BestHub
Sign in
Tagged articles

API design

301 articles · Page 1 of 4
Architect's Guide
Architect's Guide
Jun 19, 2026 · Frontend Development

Essential API Specs for Front‑End/Back‑End Separation: A Practical Guide

The article explains why front‑end/back‑end separation is needed, outlines the challenges of the MVC era, describes the SPA‑based separation model, and provides a detailed, versioned interface specification—including request/response formats, mock server workflow, and special field rules—to streamline collaborative development.

AJAXAPI designfront-end back-end separation
0 likes · 11 min read
Essential API Specs for Front‑End/Back‑End Separation: A Practical Guide
Linyb Geek Road
Linyb Geek Road
May 15, 2026 · Backend Development

8 Practical API Idempotency Solutions to Eliminate Duplicate Requests (Pitfall Guide)

The article explains the causes of duplicate requests in distributed systems, defines idempotency, and presents eight concrete implementation strategies—including token mechanisms, unique database indexes, optimistic and pessimistic locks, distributed locks, state machines, request serial numbers, and MQ‑based handling—each with code samples, advantages, drawbacks, and usage guidelines.

API designSpring Bootdatabase
0 likes · 35 min read
8 Practical API Idempotency Solutions to Eliminate Duplicate Requests (Pitfall Guide)
Linyb Geek Road
Linyb Geek Road
May 15, 2026 · Backend Development

Idempotency in Practice: Handling the Same Key with Different Parameters

The article explains why simple key‑based idempotency fails when a second request carries different parameters, and demonstrates how to use database row locks, request fingerprinting, state machines, and explicit error handling to guarantee safe, non‑duplicate execution in payment‑critical APIs.

API designMessage QueueState Machine
0 likes · 13 min read
Idempotency in Practice: Handling the Same Key with Different Parameters
Java Tech Enthusiast
Java Tech Enthusiast
May 13, 2026 · Backend Development

Why Adding Spring HATEOAS Stops Front‑End Teams From Chasing Swagger Updates

The article explains how integrating Spring HATEOAS transforms a Level‑2 REST API into a hypermedia‑driven Level‑3 API, automatically exposing actionable links, reducing front‑end state‑handling, enabling type‑safe URL generation, and simplifying RBAC integration, thereby eliminating the need for constant Swagger revisions.

API designRESTSpring
0 likes · 7 min read
Why Adding Spring HATEOAS Stops Front‑End Teams From Chasing Swagger Updates
ITPUB
ITPUB
Apr 25, 2026 · Interview Experience

How to Design a Billion‑Scale URL Shortening System for an Interview

This article walks through the complete interview‑style design of a billion‑scale URL shortener, covering requirements, capacity estimation, API definitions, database schema, short‑code generation algorithms, sharding, caching, load balancing, rate limiting, and expiration handling, while illustrating each step with concrete examples and calculations.

API designCachingSystem Design
0 likes · 24 min read
How to Design a Billion‑Scale URL Shortening System for an Interview
MeowKitty Programming
MeowKitty Programming
Apr 23, 2026 · Backend Development

Why Java Developers Should Re‑Emphasize API Design in the AI Era

Java developers using AI to generate code find speed gains, but vague API boundaries cause AI to misinterpret intent; clear, well‑named, constrained interfaces are essential for reliable AI assistance, making API design a core factor in future development productivity.

AI code generationAPI designBackend Development
0 likes · 6 min read
Why Java Developers Should Re‑Emphasize API Design in the AI Era
Tech Musings
Tech Musings
Apr 22, 2026 · Fundamentals

Go Standard Library Adds UUID Support with a Streamlined V4/V7 API

The Go team introduced a new uuid package to the standard library, offering lightweight functions for generating, parsing, serializing, and comparing UUID version 4 and version 7 values, integrating with database/sql, using a [16]byte type compatible with google/uuid, and providing detailed design rationale, implementation details, and a comparison with the existing third‑party library.

API designGoUUID
0 likes · 11 min read
Go Standard Library Adds UUID Support with a Streamlined V4/V7 API
java1234
java1234
Mar 26, 2026 · Backend Development

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

The article examines why a company might require every HTTP API to use POST, compares GET and POST characteristics, discusses RESTful principles, outlines the trade‑offs of a POST‑only policy, and offers practical guidance for choosing the right method based on business needs.

API designHTTPPOST
0 likes · 10 min read
Why Some Companies Force All APIs to Use POST – Pros, Cons, and Best Practices
Ray's Galactic Tech
Ray's Galactic Tech
Mar 22, 2026 · Backend Development

Why Go Refuses Default Parameters: The ‘Deliberate Poverty’ Behind Its Design

Go has refused default parameters for 15 years, a choice rooted in its philosophy of explicitness over implicit behavior; the article examines this deliberate ‘poverty’, explores the pitfalls of default arguments, and presents alternative patterns like wrapper functions, config structs, functional options, and pointer checks with real code examples.

API designDefault ParametersGo
0 likes · 27 min read
Why Go Refuses Default Parameters: The ‘Deliberate Poverty’ Behind Its Design
LuTiao Programming
LuTiao Programming
Mar 19, 2026 · Backend Development

Why 90% of Developers Get Java REST API Design Wrong—and the Correct Approach

Most teams treat REST APIs as merely functional, leading to chaotic naming, frequent breaking changes, rising front‑end costs, and JVM pressure; this article re‑examines REST’s constraint‑based architecture and presents concrete Java‑centric design principles, best‑practice guidelines, and implementation examples to build sustainable, evolvable APIs.

API designJAX-RSJava
0 likes · 9 min read
Why 90% of Developers Get Java REST API Design Wrong—and the Correct Approach
Architecture Digest
Architecture Digest
Mar 3, 2026 · Backend Development

Why Do Some Companies Force All APIs to Use POST? Pros, Cons, and Real‑World Insights

An experienced developer reflects on a Zhihu question about mandating POST for all interfaces, compares GET and POST characteristics, shares personal practices, presents community opinions on RESTful benefits and drawbacks, and describes his company's concrete API rule using a single POST/action endpoint with protobuf and gRPC integration.

API designHTTP methodsPOST vs GET
0 likes · 10 min read
Why Do Some Companies Force All APIs to Use POST? Pros, Cons, and Real‑World Insights
Architect's Guide
Architect's Guide
Feb 28, 2026 · Backend Development

Mastering Consistent API Design: 22 Essential Best Practices

This guide presents 22 practical best‑practice rules for designing consistent, resource‑oriented RESTful APIs, covering naming conventions, URL structure, parameter casing, versioning, monitoring endpoints, security measures, pagination, field selection, CORS, error handling, and more, with concrete code examples.

API designHTTP methodsREST
0 likes · 9 min read
Mastering Consistent API Design: 22 Essential Best Practices
SpringMeng
SpringMeng
Feb 17, 2026 · Backend Development

Building an MCP Service with Spring Boot 3 and OpenSpec: A Hands‑On Demo

This article walks through the complete development of a minimal Model Context Protocol (MCP) server using Spring Boot 3 and Server‑Sent Events, illustrating how OpenSpec drives the workflow from proposal and task breakdown to design, implementation, testing, and integration with Claude Code.

API designJSON-RPCJava
0 likes · 13 min read
Building an MCP Service with Spring Boot 3 and OpenSpec: A Hands‑On Demo
Top Architect
Top Architect
Feb 11, 2026 · Backend Development

Designing Clean API Response Wrappers in Spring Boot

This article explains how to design a consistent JSON response format for Spring Boot APIs, covering status‑code conventions, message handling, a reusable Result wrapper class, controller simplification, and a global @ResponseResult annotation with interceptor and advice for automatic response packaging.

@ControllerAdviceAPI designAnnotation
0 likes · 10 min read
Designing Clean API Response Wrappers in Spring Boot
TonyBai
TonyBai
Jan 24, 2026 · Fundamentals

After Four Years of Go Generics, Generic Methods Are Finally Arriving

Four years after Go introduced generics, the language’s core team has proposed adding generic methods, a change that resolves the long‑standing asymmetry between generic functions and types, improves API fluency, and reshapes code organization while preserving backward compatibility, though interface support remains limited.

API designGoInterfaces
0 likes · 12 min read
After Four Years of Go Generics, Generic Methods Are Finally Arriving
AI Engineering
AI Engineering
Jan 22, 2026 · Artificial Intelligence

MCP Isn’t Broken – It’s Your Server Design, Not the Protocol

The article argues that the recent hype around Skills and the criticism of MCP stem from a mindset problem: developers treat MCP like a REST API wrapper, leading to poor server designs, and it offers six concrete design principles to build agent‑friendly MCP services.

AI ToolingAPI designAgent Design
0 likes · 11 min read
MCP Isn’t Broken – It’s Your Server Design, Not the Protocol
DevOps Coach
DevOps Coach
Jan 13, 2026 · Backend Development

10 Common JSON Mistakes Developers Make and How to Fix Them

This article outlines ten frequent JSON pitfalls—from deeply nested structures and string literals to missing timezone data and lack of versioning—provides clear before‑and‑after code examples, and offers practical guidelines to write cleaner, safer, and more maintainable JSON for APIs and configuration files.

API designConfigurationJavaScript
0 likes · 10 min read
10 Common JSON Mistakes Developers Make and How to Fix Them
Data STUDIO
Data STUDIO
Jan 8, 2026 · Backend Development

From “Magic Building Blocks” to “Clear Contracts”: 7 Pydantic v2 Features for Rock‑Solid API Design

The article examines seven new Pydantic v2 capabilities—TypeAdapter, Annotated + Field, deterministic validators, precise serialization hooks, computed_field, RootModel, and ConfigDict—showing how each resolves common API‑validation pain points, improves contract clarity, and boosts performance with concrete code examples and a FastAPI integration.

API designComputed FieldData Validation
0 likes · 26 min read
From “Magic Building Blocks” to “Clear Contracts”: 7 Pydantic v2 Features for Rock‑Solid API Design
DevOps Coach
DevOps Coach
Dec 11, 2025 · Backend Development

Designing Clear and Consistent RESTful APIs: Best Practices

This guide teaches you how to design clean, consistent RESTful APIs by following proven best practices for resource modeling, URL design, filtering, sorting, pagination, proper HTTP methods, status codes, error handling, and versioning to avoid common pitfalls and improve maintainability.

API designError handlingFiltering
0 likes · 5 min read
Designing Clear and Consistent RESTful APIs: Best Practices
Architect-Kip
Architect-Kip
Nov 25, 2025 · Backend Development

Mastering API Interface Design: Principles, Naming, Parameters, and Security

This guide outlines comprehensive API interface design best practices, covering design principles, naming conventions, parameter structures, return code standards, security measures, and a reusable documentation template to ensure flexible, efficient, and secure service development.

API designNaming Conventionsinterface design
0 likes · 16 min read
Mastering API Interface Design: Principles, Naming, Parameters, and Security
Architect
Architect
Nov 10, 2025 · Backend Development

How to Build Secure, Idempotent APIs: Keys, Tokens, and Anti‑Replay Strategies

This article explains how to design secure and reliable APIs for third‑party integration by covering API key generation, AK/SK authentication, callback URLs, permission models, token mechanisms, signature creation, replay‑attack prevention, HTTPS encryption, rate limiting, logging, data masking, idempotency, versioning, standardized response formats and documentation tools.

API designauthenticationidempotency
0 likes · 28 min read
How to Build Secure, Idempotent APIs: Keys, Tokens, and Anti‑Replay Strategies
Top Architect
Top Architect
Oct 6, 2025 · Backend Development

Designing Clean API Response Wrappers with Annotations and Interceptors

This article explains how to structure API responses in a microservice environment by using a standard JSON format, custom status code ranges, a Result wrapper class, and Spring annotations with interceptors to automatically package and handle responses and errors in a clean, maintainable way.

API designSpringannotations
0 likes · 10 min read
Designing Clean API Response Wrappers with Annotations and Interceptors
IT Architects Alliance
IT Architects Alliance
Sep 28, 2025 · Cloud Native

How to Build a Future‑Proof Architecture for Digital Transformation

This article examines the architectural challenges and opportunities of digital transformation, outlines layered, API‑first, and data‑driven design principles, and provides practical technology‑selection and implementation roadmaps to help enterprises create resilient, scalable, and business‑centric IT systems.

API designData-DrivenIT Architecture
0 likes · 12 min read
How to Build a Future‑Proof Architecture for Digital Transformation
Java Architect Essentials
Java Architect Essentials
Sep 21, 2025 · Backend Development

Why Unified Controller Interfaces Matter: Best Practices and AOP in Java

This article explains common pitfalls in Java controller interface design—such as inconsistent return formats, missing failure handling, and inappropriate parameters—and demonstrates how a unified ResultBean response combined with AOP logging and exception handling can improve code readability, maintainability, and testability.

AOPAPI designResultBean
0 likes · 11 min read
Why Unified Controller Interfaces Matter: Best Practices and AOP in Java
IT Services Circle
IT Services Circle
Sep 15, 2025 · Backend Development

How to Ace a Billion‑Scale URL Shortening System Design Interview

This article walks through the complete design of a high‑performance, highly available URL shortener—covering business value, requirement analysis, capacity estimation, API definitions, database schema, key generation algorithms, sharding, caching, load balancing, and expiration cleanup—so you can impress interviewers with a thorough, scalable solution.

API designSystem DesignURL shortener
0 likes · 25 min read
How to Ace a Billion‑Scale URL Shortening System Design Interview
BirdNest Tech Talk
BirdNest Tech Talk
Sep 11, 2025 · Backend Development

Why Go Introduced encoding/json/v2: Fixes, New API, and Performance Gains

The article analyzes the long‑standing issues of Go's original encoding/json package, explains the design and API of the experimental encoding/json/v2 and jsontext packages, and shows how the new implementation improves correctness, flexibility, and performance while preserving compatibility.

API designGoencoding/json
0 likes · 23 min read
Why Go Introduced encoding/json/v2: Fixes, New API, and Performance Gains
Java Captain
Java Captain
Aug 22, 2025 · Backend Development

Designing Clean API Responses in Java: From JSON Structure to Global Wrappers

This article explains how to design a standardized JSON response format for Java back‑end APIs, introduces a Result wrapper class, and shows how to automate response wrapping using a custom @ResponseResult annotation, interceptors, and Spring's ResponseBodyAdvice for cleaner, more maintainable code.

API designJSON responseJava
0 likes · 7 min read
Designing Clean API Responses in Java: From JSON Structure to Global Wrappers
Java Web Project
Java Web Project
Aug 14, 2025 · Backend Development

Why a Unified Controller Response Format Is Essential: Best Practices and AOP Implementation

The article explains how inconsistent API return types, missing error handling, irrelevant or complex parameters, and lack of proper result objects lead to maintenance headaches, and demonstrates a disciplined approach using a generic ResultBean, standardized controller conventions, and Spring AOP for logging and exception handling.

AOPAPI designJava
0 likes · 11 min read
Why a Unified Controller Response Format Is Essential: Best Practices and AOP Implementation
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 designHTTPMicroservices
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
Su San Talks Tech
Su San Talks Tech
May 30, 2025 · Backend Development

How to Build Secure, Reliable API Controllers: Signatures, Encryption, Rate Limiting and More

This article explains how to design robust API controller interfaces by covering signature verification, RSA encryption, IP whitelisting, rate limiting, parameter validation, unified response formats, exception handling, request logging, idempotency, record limits, stress testing, asynchronous processing, data masking, and comprehensive documentation.

API designLoggingbackend
0 likes · 15 min read
How to Build Secure, Reliable API Controllers: Signatures, Encryption, Rate Limiting and More
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 designFastAPIRBAC
0 likes · 10 min read
Master Advanced FastAPI Routing: Modular APIs, Versioning, and RBAC
Lin is Dream
Lin is Dream
Apr 29, 2025 · Backend Development

When to Use Body vs Params in Spring Boot APIs: A Practical Guide

This article explains the differences between Body and Params parameters in Spring Boot, covering various Content‑Type configurations such as query, x‑www‑form‑urlencoded, form‑data, binary, and JSON, and provides code examples and a clear comparison table to help developers choose the right approach for stable and efficient API design.

API designBody vs ParamsContent-Type
0 likes · 6 min read
When to Use Body vs Params in Spring Boot APIs: A Practical Guide
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 designRESTfulStatus Codes
0 likes · 5 min read
The Evolution and Chaos of HTTP Status Codes and RESTful API Design
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 designCouplingFeign
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 DevelopmentData Validation
0 likes · 10 min read
Pydantic & FastAPI: Optional Fields, Nested Models, and Advanced Validation
Java Backend Full-Stack
Java Backend Full-Stack
Mar 18, 2025 · Backend Development

18 Essential Practices for Designing Robust Backend APIs

The article outlines eighteen critical considerations for designing backend interfaces, ranging from documentation format and unified parameter schemas to encryption, idempotency, versioning, and monitoring, providing interview-ready insights that can impress hiring managers.

API designbackendidempotency
0 likes · 5 min read
18 Essential Practices for Designing Robust Backend APIs
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 DevelopmentPerformance Optimization
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 CodesTraceability
0 likes · 15 min read
Designing Effective API Error Codes and Their Propagation in Complex Systems
Programmer XiaoFu
Programmer XiaoFu
Nov 14, 2024 · Backend Development

Designing Elegant API Controllers: Security, Idempotency, and Best Practices

This guide walks through building robust API controller interfaces by covering request signing, RSA encryption, IP whitelisting, rate limiting, parameter validation, unified response formats, exception handling, logging, idempotent design, request size limits, stress testing, asynchronous processing, data masking, and comprehensive documentation.

API designLoggingbackend
0 likes · 15 min read
Designing Elegant API Controllers: Security, Idempotency, and Best Practices
Su San Talks Tech
Su San Talks Tech
Nov 12, 2024 · Backend Development

Designing Secure, Reliable API Controllers: Signatures, Encryption, Rate Limiting & More

This article outlines best‑practice techniques for building robust API controller interfaces, covering request signing, RSA encryption, IP whitelisting, rate limiting, parameter validation, unified responses, exception handling, logging, idempotency, record limits, stress testing, asynchronous processing, data masking, and comprehensive documentation.

API designsecurity
0 likes · 16 min read
Designing Secure, Reliable API Controllers: Signatures, Encryption, Rate Limiting & More
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 designKISScode simplicity
0 likes · 24 min read
Simplifying Complexity: Principles and Practices for Cleaner Software Design
phodal
phodal
Oct 20, 2024 · Backend Development

Why Streaming BFF Is the Missing Glue for AI‑Native Apps

The article proposes a Streaming Backend‑for‑Frontend (BFF) layer to unify heterogeneous AI agents, handle Server‑Sent Events streams, and resolve interface inconsistencies, offering a practical architecture for generative‑AI‑native systems across IDEs, DevOps, and team‑AI scenarios.

AI ArchitectureAPI designBackend Development
0 likes · 13 min read
Why Streaming BFF Is the Missing Glue for AI‑Native Apps
21CTO
21CTO
Oct 17, 2024 · Backend Development

Why REST Still Beats GraphQL: Hidden Costs and Practical Advantages

While GraphQL promises precise data fetching and reduced bandwidth, this article examines its hidden drawbacks—complex queries, performance hits, rate‑limit challenges, and evolving schema complexity—showing why REST remains the more reliable, widely supported API standard for most applications.

API designGraphQLREST
0 likes · 7 min read
Why REST Still Beats GraphQL: Hidden Costs and Practical Advantages
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 designBackend DevelopmentSpring Boot
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
Su San Talks Tech
Su San Talks Tech
Oct 5, 2024 · Backend Development

Mastering Idempotency: Design Patterns and Code Solutions for Reliable APIs

Idempotency ensures that repeated API calls produce the same result without side effects, and this guide explains its principles, common scenarios like payments and messaging, root causes of idempotency failures, and multiple implementation strategies—including unique constraints, optimistic and pessimistic locks, distributed locks, token mechanisms, state machines, and deduplication tables—with practical code examples.

API designbackenddistributed systems
0 likes · 14 min read
Mastering Idempotency: Design Patterns and Code Solutions for Reliable APIs
Architect
Architect
Sep 20, 2024 · Backend Development

18 Essential API Design Rules Every Backend Engineer Should Follow

This article presents a comprehensive checklist of 18 practical API design rules—including signature, encryption, IP whitelisting, rate limiting, validation, unified responses, exception handling, logging, idempotency, pagination, stress testing, async processing, data masking, documentation, request methods, headers, batch operations, and single‑responsibility principles—to help developers build secure, maintainable, and high‑performance services.

API designbackenddocumentation
0 likes · 18 min read
18 Essential API Design Rules Every Backend Engineer Should Follow
Architecture Breakthrough
Architecture Breakthrough
Sep 13, 2024 · R&D Management

How to Turn Last-Minute API Crises into Team Cohesion: A Step-by-Step Guide

Facing a critical production deadline, the author shares a three‑step communication and process framework—empathic praise, collaborative brainstorming for an interface delivery review, and reflective design improvement—to strengthen middle‑platform team cohesion and establish robust API governance practices.

API designmiddle platformprocess improvement
0 likes · 7 min read
How to Turn Last-Minute API Crises into Team Cohesion: A Step-by-Step Guide
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 designJavaSpring Boot
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 designRabbitMQWebSocket
0 likes · 8 min read
Design of a Unified WebSocket Messaging Service for Backend Systems
JavaEdge
JavaEdge
Aug 18, 2024 · Backend Development

When Should You Use Fine‑Grained vs Coarse‑Grained Resources in REST APIs?

This article explains how to choose between fine‑grained and coarse‑grained resource designs in REST APIs, illustrating trade‑offs with blog‑post examples, showing how to model business processes as intent resources, and discussing the impact of avoiding PUT in favor of CQRS.

API designCQRSCRUD
0 likes · 23 min read
When Should You Use Fine‑Grained vs Coarse‑Grained Resources in REST APIs?
Open Source Tech Hub
Open Source Tech Hub
Aug 12, 2024 · Backend Development

Mastering RESTful API Design: Principles, Best Practices, and Real-World Examples

This article explains the origins of REST, why modern developers must follow RESTful conventions, and provides a step‑by‑step guide—including domain naming, versioning, endpoint design, HTTP verbs, filtering, status codes, error handling, hypermedia links, and data formats—illustrated with concrete code snippets.

API designEndpointsFiltering
0 likes · 14 min read
Mastering RESTful API Design: Principles, Best Practices, and Real-World Examples
Architect
Architect
Aug 5, 2024 · Backend Development

How to Build a Scalable WebSocket Communication Service with Reliable Messaging

This article outlines the design of an internal WebSocket communication service that abstracts real‑time messaging, reduces code coupling, supports various business scenarios, ensures reliable delivery with RabbitMQ, defines unified APIs and message formats, and demonstrates a DDD‑based project structure for easy integration.

API designDDDMessage Queue
0 likes · 10 min read
How to Build a Scalable WebSocket Communication Service with Reliable Messaging
Rare Earth Juejin Tech Community
Rare Earth Juejin Tech Community
Aug 1, 2024 · Backend Development

Backend API Design Best Practices

This article outlines comprehensive backend API design guidelines, covering parameter validation, extensibility, idempotency, logging, thread‑pool isolation, third‑party error handling, asynchronous processing, parallel queries, rate limiting, security, lock granularity, and strategies to avoid long‑running transactions.

API designAsynchronousLogging
0 likes · 11 min read
Backend API Design Best Practices
iKang Technology Team
iKang Technology Team
Jul 31, 2024 · Backend Development

What Is a RESTful API? Design Principles, Implementation Guidelines, and Common Pitfalls

A RESTful API is an HTTP‑based design that treats each resource as a URI, uses standard verbs (GET, POST, PUT, PATCH, DELETE) for CRUD operations, returns appropriate status codes, supports content negotiation, versioned secure endpoints, clear noun‑based naming, pagination, filtering, HATEOAS links, and avoids embedding actions or verbs in URLs.

API designHTTPRESTful API
0 likes · 8 min read
What Is a RESTful API? Design Principles, Implementation Guidelines, and Common Pitfalls
JD Tech Talk
JD Tech Talk
Jul 29, 2024 · Backend Development

Best Practices for Service Design and API Development in Enterprise Systems

This article presents comprehensive guidelines for designing robust, secure, and maintainable enterprise services, covering API path conventions, request handling, input/output parameter design, business logic recommendations, exception handling, dependency management, monitoring, degradation strategies, encryption, and system admission practices.

API designEncryptionError handling
0 likes · 19 min read
Best Practices for Service Design and API Development in Enterprise Systems
JD Cloud Developers
JD Cloud Developers
Jul 29, 2024 · Backend Development

Designing Robust Backend Services: Path Standards, Security, Monitoring, and Degradation Strategies

This article outlines comprehensive best‑practice guidelines for designing robust, secure, and maintainable backend services—covering API path conventions, request handling, parameter design, error codes, dependency management, monitoring, degradation strategies, legacy service handling, encryption, access control, and tamper‑proof mechanisms, with practical code examples.

API designEncryptionMonitoring
0 likes · 18 min read
Designing Robust Backend Services: Path Standards, Security, Monitoring, and Degradation Strategies
Top Architect
Top Architect
Jul 17, 2024 · Backend Development

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

This article explains how to design a unified API response format in Spring Boot, defining a JSON result structure with code, message, and data, organizing status codes, using @ResponseResult annotation, implementing interceptors and ResponseBodyAdvice to automatically wrap controller outputs, and offers optimization tips for clean backend development.

API designBackend DevelopmentSpring Boot
0 likes · 10 min read
Designing a Unified API Response Structure with Annotations and Interceptors in Spring Boot
JD Tech
JD Tech
Jul 17, 2024 · Information Security

Service Design Tips and Security Practices for Robust API Development

This article presents comprehensive guidelines for designing flexible, secure, and maintainable API services, covering standardized paths, request handling, parameter design, business logic, exception management, dependency classification, monitoring, degradation strategies, handling legacy services, and encryption measures to ensure robust service architecture.

API designEncryptionError handling
0 likes · 19 min read
Service Design Tips and Security Practices for Robust API Development
JD Retail Technology
JD Retail Technology
Jul 12, 2024 · Backend Development

Service Design Tips and Best Practices for Robust API Development

This article explores essential service design considerations beyond standard guidelines, covering API path structuring, request handling, parameter design, security measures, monitoring, degradation strategies, and code examples to help build flexible, secure, and maintainable backend services.

API designBackend DevelopmentMicroservices
0 likes · 19 min read
Service Design Tips and Best Practices for Robust API Development
Architecture Breakthrough
Architecture Breakthrough
Jul 1, 2024 · Fundamentals

Why Defensive Programming Is More Than Just Defensive Coding

The article explains how defensive programming extends beyond simple input checks to include comprehensive data validation, parameter verification, illegal data handling, and collaborative design practices that protect systems from both code errors and external misuse.

API designDefensive Programmingcode quality
0 likes · 7 min read
Why Defensive Programming Is More Than Just Defensive Coding
Selected Java Interview Questions
Selected Java Interview Questions
Jun 30, 2024 · Backend Development

Design and Implementation of a Unified WebSocket Communication Service for Backend Systems

This article presents a comprehensive design of a unified WebSocket communication service that abstracts messaging, improves reliability with RabbitMQ, replaces polling with push, and provides standardized APIs and message formats for backend developers to quickly integrate real‑time features.

API designRabbitMQReliability
0 likes · 9 min read
Design and Implementation of a Unified WebSocket Communication Service for Backend Systems
Top Architect
Top Architect
Jun 19, 2024 · Backend Development

Standardizing Java API Interfaces and Controller Practices with ResultBean and AOP

The article explains common pitfalls in Java API design—such as inconsistent return formats, missing error handling, unnecessary parameters, and complex inputs—then proposes a unified ResultBean response model, controller conventions, and AOP-based logging and exception handling to improve code readability and maintainability.

AOPAPI designJava
0 likes · 12 min read
Standardizing Java API Interfaces and Controller Practices with ResultBean and AOP
Ops Development & AI Practice
Ops Development & AI Practice
Jun 16, 2024 · Industry Insights

Protocol Buffers vs Swagger: Which Is Best for High‑Performance APIs?

This article compares Google’s Protocol Buffers and the Swagger/OpenAPI framework, detailing their features, data formats, use cases, flexibility, development workflows, and why Google created protobuf, helping developers choose the right tool for high‑performance data serialization or comprehensive API documentation.

API designData SerializationOpenAPI
0 likes · 7 min read
Protocol Buffers vs Swagger: Which Is Best for High‑Performance APIs?
Java Architect Essentials
Java Architect Essentials
Jun 11, 2024 · Backend Development

Why Consistent API Responses Matter: A Java Controller & AOP Guide

The article explains common pitfalls in Java API design—such as inconsistent return formats, missing error handling, irrelevant parameters, and improper use of maps or JSON strings—and demonstrates how adopting a unified ResultBean structure together with AOP can improve readability, error management, and testability of backend services.

AOPAPI designJava
0 likes · 10 min read
Why Consistent API Responses Matter: A Java Controller & AOP Guide
macrozheng
macrozheng
May 30, 2024 · Backend Development

18 Essential API Design Rules Every Backend Developer Should Follow

Learn 18 essential API design rules covering signature, encryption, IP whitelisting, rate limiting, parameter validation, unified responses, exception handling, logging, idempotency, pagination, stress testing, async processing, data masking, documentation, request methods, headers, batch operations, and single‑responsibility principles for robust backend services.

API designrate limitingsecurity
0 likes · 17 min read
18 Essential API Design Rules Every Backend Developer Should Follow
21CTO
21CTO
May 25, 2024 · Backend Development

Mastering E‑Commerce API Design: Best Practices, Protocols, and Versioning

This article walks developers through the fundamentals of designing robust e‑commerce APIs, covering CRUD operations, protocol choices such as REST, GraphQL and gRPC, versioning strategies, rate limiting, CORS, and best practices for request idempotency and backward compatibility.

API designCRUDGraphQL
0 likes · 8 min read
Mastering E‑Commerce API Design: Best Practices, Protocols, and Versioning
Su San Talks Tech
Su San Talks Tech
May 24, 2024 · Backend Development

18 Must‑Know API Design Rules for Secure and Scalable Backends

This article presents 18 essential API design rules covering signature verification, encryption, IP whitelisting, rate limiting, parameter validation, unified responses and error handling, logging, idempotency, request size limits, stress testing, asynchronous processing, data masking, comprehensive documentation, proper HTTP methods, header usage, batch operations, and single‑responsibility principles.

API designidempotencyrate limiting
0 likes · 17 min read
18 Must‑Know API Design Rules for Secure and Scalable Backends
21CTO
21CTO
May 21, 2024 · Backend Development

REST vs GraphQL: When to Choose the Right API Architecture

This article compares REST and GraphQL API styles, explaining their principles, advantages, disadvantages, typical use cases, and providing code samples so developers can decide which architecture best fits their project requirements.

API designBackend DevelopmentCode examples
0 likes · 12 min read
REST vs GraphQL: When to Choose the Right API Architecture
21CTO
21CTO
May 6, 2024 · Backend Development

Discover Microsoft’s TypeSpec: A New Language to Simplify API Development

Microsoft’s newly released TypeSpec language offers a lightweight, open‑source, API‑centric approach that lets developers describe APIs with minimal types, compile to OpenAPI, JSON Schema, and Protobuf, and leverage modern tooling for faster, more reusable code.

API designOpenAPITypeSpec
0 likes · 5 min read
Discover Microsoft’s TypeSpec: A New Language to Simplify API Development
Top Architect
Top Architect
Apr 15, 2024 · Backend Development

Designing a Scalable Backend Architecture with API Layer and BFF for a Supply‑Chain System

This article analyzes common problems in a large‑scale supply‑chain backend—such as unclear service boundaries, tangled dependencies, and client‑specific adaptations—and proposes a layered solution using a dedicated API layer, BFF pattern, Spring Cloud components, and clear team division to improve modularity, reduce code duplication, and streamline development.

API designBFFMicroservices
0 likes · 13 min read
Designing a Scalable Backend Architecture with API Layer and BFF for a Supply‑Chain System
Ops Development & AI Practice
Ops Development & AI Practice
Apr 14, 2024 · Backend Development

Designing a Scalable Booking System: Architecture, APIs, and Go Implementation

This article outlines the functional and non‑functional requirements of a booking platform, proposes a micro‑service‑based backend architecture, presents UML component and sequence diagrams, details database schemas, defines RESTful APIs, and provides Go code examples for user registration and booking creation, offering a comprehensive design blueprint.

API designMicroservicesbackend
0 likes · 10 min read
Designing a Scalable Booking System: Architecture, APIs, and Go Implementation
IT Services Circle
IT Services Circle
Apr 11, 2024 · Backend Development

An Introduction to TypeSpec: Features, Usage Examples, and Quick Start Guide

This article introduces TypeSpec, a lightweight, extensible language for describing REST, OpenAPI, gRPC and other APIs, outlines its key features, demonstrates how to generate OpenAPI, JSON Schema and Protobuf files, and provides step‑by‑step instructions for installing the compiler, setting up the VS Code extension, creating a project, and compiling a sample service.

API designBackend DevelopmentOpenAPI
0 likes · 5 min read
An Introduction to TypeSpec: Features, Usage Examples, and Quick Start Guide
21CTO
21CTO
Apr 3, 2024 · Backend Development

Mastering API Design: Principles, Best Practices, and Real‑World Examples

This comprehensive guide explains what APIs are, outlines essential design principles, and presents best‑practice techniques—including RESTful patterns, resource‑oriented design, proper HTTP methods, status codes, versioning, pagination, caching, error handling, authentication, and documentation—to help developers build scalable, secure, and maintainable interfaces.

API designHTTP methodsREST
0 likes · 17 min read
Mastering API Design: Principles, Best Practices, and Real‑World Examples
Architect
Architect
Jan 22, 2024 · Backend Development

Designing a Unified API Response and Global Exception Handling in Spring Boot

This article walks through creating a standardized JSON response structure with a Result enum and wrapper class, demonstrates how to return it from controllers, implements a @ControllerAdvice‑based global exception handler with custom exceptions, and configures Logback for comprehensive logging in Spring Boot applications.

API designJavaLogback
0 likes · 17 min read
Designing a Unified API Response and Global Exception Handling in Spring Boot
Architect
Architect
Dec 19, 2023 · Backend Development

How Graceful Response Simplifies Spring Boot API Error Handling

This article analyzes the inefficiencies and duplication in typical Spring Boot controller code, introduces the Graceful Response library, and provides step‑by‑step instructions—including Maven integration, annotation setup, controller and service examples, exception mapping, validation handling, and response style configuration—to achieve cleaner, unified API responses.

API designBackend DevelopmentException Management
0 likes · 12 min read
How Graceful Response Simplifies Spring Boot API Error Handling
21CTO
21CTO
Nov 29, 2023 · Backend Development

Designing Clear API Error Codes: Lessons from HTTP Status Practices

This article explains how to design consistent API error codes and messages by borrowing the structured approach of HTTP status codes, covering code segmentation, personalized messages, and unified monitoring to improve developer communication and reduce maintenance overhead.

API designError Codeshttp status
0 likes · 5 min read
Designing Clear API Error Codes: Lessons from HTTP Status Practices