Tag

API design

1 views collected around this technical thread.

macrozheng
macrozheng
Jun 11, 2025 · Backend Development

Why Do Some Companies Force All APIs to Use POST? Pros, Cons, and Best Practices

The article examines why some companies mandate POST for every API, compares GET and POST characteristics, discusses RESTful principles, weighs the benefits and drawbacks, and offers practical guidance while showcasing an open‑source microservice project for deeper learning.

API designGETHTTP
0 likes · 11 min read
Why Do Some Companies Force All APIs to Use POST? Pros, Cons, and Best Practices
Architect's Guide
Architect's Guide
Jun 8, 2025 · Fundamentals

Master Java API Design: 25 Essential Best‑Practice Rules from Effective Java

This article distills key guidelines from Effective Java, covering static factory methods, builder patterns, singleton protection, utility class design, memory‑leak avoidance, equals/hashCode contracts, composition over inheritance, generics, enums, exception handling, and many other best‑practice rules to help Java developers write cleaner, safer, and more maintainable code.

API designEffective JavaJava
0 likes · 24 min read
Master Java API Design: 25 Essential Best‑Practice Rules from Effective Java
Code Mala Tang
Code Mala Tang
May 10, 2025 · Backend Development

Master FastAPI Request Body Validation with Pydantic Models

This guide explains how FastAPI uses Pydantic models to define, validate, and parse JSON and form request bodies, set default values and custom rules, handle nested structures, and return response models, providing a type‑safe, efficient way to build backend APIs.

API designBackend DevelopmentPydantic
0 likes · 8 min read
Master FastAPI Request Body Validation with Pydantic Models
Code Mala Tang
Code Mala Tang
May 1, 2025 · Backend Development

Master Advanced FastAPI Routing: Modular APIs, Versioning, and RBAC

This tutorial explains how to build scalable, maintainable FastAPI APIs by modularizing routers, implementing path‑based version control, centralizing dependency injection, applying role‑based access control, using custom middleware, and nesting routers for complex applications.

API designRBACVersioning
0 likes · 10 min read
Master Advanced FastAPI Routing: Modular APIs, Versioning, and RBAC
Java Tech Enthusiast
Java Tech Enthusiast
Apr 26, 2025 · Backend Development

The Evolution and Chaos of HTTP Status Codes and RESTful API Design

The article traces how an early AJAX API that used only HTTP 200 and a simple JSON wrapper devolved into a tangled mix of proper RESTful codes, custom three‑digit‑plus statuses, pseudo‑resources, PATCH work‑arounds, and finally a pragmatic scheme that keeps 200 for success, adds extended numeric categories, and adopts verb‑adjective‑resource method names for clarity.

API designHTTPRESTful
0 likes · 5 min read
The Evolution and Chaos of HTTP Status Codes and RESTful API Design
Top Architect
Top Architect
Apr 15, 2025 · Backend Development

From Wild API Errors to Structured RESTful Practices: A Top Architect’s Journey

The article narrates a top architect’s experience with early API error handling, the chaos caused by non‑standard HTTP status codes, the shift toward RESTful conventions, and later promotional offers for AI tools, illustrating both technical lessons and marketing pitches.

API designError HandlingHTTP status codes
0 likes · 10 min read
From Wild API Errors to Structured RESTful Practices: A Top Architect’s Journey
Top Architect
Top Architect
Apr 12, 2025 · Backend Development

Decoupling Front‑End and Back‑End with a Dedicated TPS Microservice for Third‑Party Push Integration

This article analyzes the coupling problems caused by multiple controller calls and third‑party push interfaces, proposes a TPS microservice to centralize third‑party interactions, demonstrates Java Feign interfaces and enum‑based routing, and shows how backend and frontend can achieve low‑coupling architecture while reducing code duplication.

API designJavaMicroservices
0 likes · 9 min read
Decoupling Front‑End and Back‑End with a Dedicated TPS Microservice for Third‑Party Push Integration
Code Mala Tang
Code Mala Tang
Mar 22, 2025 · Backend Development

Pydantic & FastAPI: Optional Fields, Nested Models, and Advanced Validation

Learn how to leverage Pydantic in FastAPI to handle optional fields, validate nested data structures, enforce complex business rules with model validators, forbid extra fields, work with polymorphic models, and validate query and path parameters, all illustrated with clear Python code examples.

API designBackend DevelopmentPydantic
0 likes · 10 min read
Pydantic & FastAPI: Optional Fields, Nested Models, and Advanced Validation
Architecture Digest
Architecture Digest
Mar 9, 2025 · Backend Development

Comparing API Architectural Styles: RPC, SOAP, REST, and GraphQL

This article examines four major API architectural styles—RPC, SOAP, REST, and GraphQL—detailing their mechanisms, advantages, disadvantages, and typical use cases, and provides guidance on selecting the most suitable style based on project requirements and constraints.

APIAPI designGraphQL
0 likes · 17 min read
Comparing API Architectural Styles: RPC, SOAP, REST, and GraphQL
DevOps
DevOps
Jan 13, 2025 · Backend Development

Comprehensive Guide to API Design, Optimization, Security, and Maintenance

This article provides a thorough guide on API (interface) fundamentals, design principles, optimization techniques, security measures, and maintenance practices, offering practical examples and code snippets for building robust, high‑performance modern backend services.

API designBackend DevelopmentVersioning
0 likes · 21 min read
Comprehensive Guide to API Design, Optimization, Security, and Maintenance
Tencent Cloud Developer
Tencent Cloud Developer
Jan 8, 2025 · Backend Development

Best Practices for Designing, Optimizing, Securing, and Maintaining APIs

This guide presents comprehensive best‑practice recommendations for building APIs—defining clear contracts, applying six design principles, optimizing performance through batching, async and caching, enforcing robust security with encryption, signing and rate‑limiting, and ensuring long‑term maintainability via versioning, documentation and structured logging.

API designBackend Developmentbest practices
0 likes · 24 min read
Best Practices for Designing, Optimizing, Securing, and Maintaining APIs
JD Tech
JD Tech
Jan 2, 2025 · Backend Development

Designing Effective API Error Codes and Their Propagation in Complex Systems

This article explains the importance of well‑designed API and database structures, outlines principles for creating clear and traceable error codes, provides response format examples, discusses error propagation strategies, highlights common pitfalls, and proposes a full‑link trace‑id logging system for backend services.

API designError CodesSystem Architecture
0 likes · 15 min read
Designing Effective API Error Codes and Their Propagation in Complex Systems
JD Tech
JD Tech
Nov 5, 2024 · Fundamentals

Simplifying Complexity: Principles and Practices for Cleaner Software Design

This article explores why simplicity is essential in software development, examines the distinction between essential and accidental complexity, presents real‑world case studies of product and code complexity, and offers practical guidelines such as KISS, single‑responsibility, API minimization, and automation to achieve more maintainable and understandable systems.

API designKISSarchitecture
0 likes · 24 min read
Simplifying Complexity: Principles and Practices for Cleaner Software Design
System Architect Go
System Architect Go
Oct 25, 2024 · Artificial Intelligence

Designing and Extending a Self‑Built ChatGPT System: Architecture, Session Management, and Scaling Strategies

This article explains how to construct a ChatGPT‑like conversational system by detailing the core dialogue flow, adding session and history management with a database, defining REST APIs, and exploring extensions such as caching, elastic scaling, and production‑ready deployment considerations.

API designCachingChatGPT
0 likes · 7 min read
Designing and Extending a Self‑Built ChatGPT System: Architecture, Session Management, and Scaling Strategies
Architect
Architect
Oct 14, 2024 · Backend Development

Designing a Unified API Response Structure with Status Codes, Annotations, and Interceptors in Spring Boot

This article explains how to create a consistent JSON API response format—including custom status codes, message fields, and a Result wrapper—by using a @ResponseResult annotation, an interceptor, and ResponseBodyAdvice in Spring Boot, while also offering tips for optimization and error handling.

API designAnnotationsBackend Development
0 likes · 7 min read
Designing a Unified API Response Structure with Status Codes, Annotations, and Interceptors in Spring Boot
IT Architects Alliance
IT Architects Alliance
Oct 8, 2024 · Backend Development

Comparing GraphQL and REST: Advantages, Trade‑offs, and Future Trends

This article provides an in‑depth comparison of GraphQL and REST API paradigms, outlining their principles, typical request examples, key differences in data fetching, flexibility, documentation, caching, error handling, performance, tooling, and guidance on choosing the appropriate approach for various project scenarios.

API designGraphQLREST
0 likes · 8 min read
Comparing GraphQL and REST: Advantages, Trade‑offs, and Future Trends
Top Architect
Top Architect
Sep 5, 2024 · Backend Development

Designing a Unified API Response Structure in Spring Boot with @ResponseResult

This article explains how to standardize API responses in Spring Boot by defining a JSON result format, using custom annotations, interceptors, and ResponseBodyAdvice to automatically wrap controller return values, while also discussing status code design, message handling, and code simplification techniques.

API designAnnotationsJava
0 likes · 10 min read
Designing a Unified API Response Structure in Spring Boot with @ResponseResult
Architecture Digest
Architecture Digest
Aug 21, 2024 · Backend Development

Design of a Unified WebSocket Messaging Service for Backend Systems

This article outlines the design and implementation of a unified WebSocket communication service, covering background motivations, project goals, core architecture, message reliability mechanisms using RabbitMQ, message classification, API specifications, and unified message formats to enable efficient, decoupled real‑time messaging across backend applications.

API designMessagingRabbitMQ
0 likes · 8 min read
Design of a Unified WebSocket Messaging Service for Backend Systems
Top Architect
Top Architect
Aug 3, 2024 · Backend Development

Standardizing API Response Structure with Custom Annotations in Spring Boot

This article explains how to design a unified JSON response format for backend services, define clear status‑code conventions, encapsulate results in a Result class, and use a custom @ResponseResult annotation together with a ResponseBodyAdvice interceptor to automatically wrap controller outputs, improving readability and error handling.

API designAnnotationsJava
0 likes · 10 min read
Standardizing API Response Structure with Custom Annotations in Spring Boot