BestHub
Sign in
Tagged articles

API Design

322 articles · Page 2 of 4
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 DesignController
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 DesignBackend
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 LimitingValidation
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 DesignRate Limitingidempotency
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 DesignCode ExamplesGraphQL
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 DesignBFFBackend
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 DesignBackenddatabase-schema
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 DesignOpenAPIProtobuf
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 DesignException ManagementJava
0 likes · 12 min read
How Graceful Response Simplifies Spring Boot API Error Handling
Senior Brother's Insights
Senior Brother's Insights
Dec 5, 2023 · Backend Development

10 Essential REST API Design Best Practices Every Backend Engineer Should Follow

This article outlines ten practical REST API design guidelines—including meaningful resource naming, proper HTTP methods and status codes, versioning, consistent error handling, query parameters, authentication, statelessness, and thorough documentation—to help developers build robust, scalable backend services.

API DesignBackendBest Practices
0 likes · 8 min read
10 Essential REST API Design Best Practices Every Backend Engineer Should Follow
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
Open Source Tech Hub
Open Source Tech Hub
Nov 18, 2023 · Backend Development

Why Some RESTful APIs Stick to GET/POST and Always Return 200

The article examines common misconceptions in RESTful API design, explaining why developers often limit interfaces to GET and POST, why some APIs return only HTTP 200 status codes, and how to decide the proper use of other methods and status codes for empty results.

API DesignHTTP methodsRESTful API
0 likes · 17 min read
Why Some RESTful APIs Stick to GET/POST and Always Return 200
macrozheng
macrozheng
Sep 18, 2023 · Backend Development

Secure & Scalable API Design: Signatures, Encryption, Rate Limiting, and More

This article outlines comprehensive best‑practice guidelines for building robust API interfaces, covering signature mechanisms, data encryption, IP whitelisting, rate limiting, parameter validation, unified responses, exception handling, logging, idempotency, request limits, performance testing, asynchronous processing, data masking, and documentation standards.

API DesignBest Practicesidempotency
0 likes · 15 min read
Secure & Scalable API Design: Signatures, Encryption, Rate Limiting, and More
Architect's Guide
Architect's Guide
Sep 2, 2023 · Backend Development

Designing an API Layer and BFF Architecture for a Large‑Scale Supply Chain System

This article examines the challenges of a complex supply‑chain system built on Spring Cloud, proposes introducing an API layer to handle aggregation, distributed calls and decoration, and further adopts a Backend‑for‑Frontend (BFF) approach to reduce service coupling, improve client‑specific optimization, and streamline team responsibilities.

API DesignBFFSpring Cloud
0 likes · 15 min read
Designing an API Layer and BFF Architecture for a Large‑Scale Supply Chain System
Architects Research Society
Architects Research Society
Jul 22, 2023 · Backend Development

Understanding JSON API: Benefits, Features, and a FitBit Case Study

This article explains what JSON API is, outlines its key advantages such as compound documents, sparse fieldsets, optional features, pagination and caching, compares it with GraphQL, and illustrates its practical use through a FitBit case study, helping readers decide if it fits their API design needs.

API DesignBackendCaching
0 likes · 12 min read
Understanding JSON API: Benefits, Features, and a FitBit Case Study
macrozheng
macrozheng
Jun 20, 2023 · Backend Development

Mastering E‑Commerce Product Module Design with the Mall Project

This article walks through the Mall project's product module—covering its architecture, feature design, database schema, and API implementation—while providing links to source code, video tutorials, and a mind‑map that together serve as a comprehensive guide for building robust e‑commerce systems.

API DesignSpringBootbackend development
0 likes · 10 min read
Mastering E‑Commerce Product Module Design with the Mall Project
Top Architect
Top Architect
May 30, 2023 · Backend Development

Designing API Error Codes and Messages: Best Practices and Standardization

This article explains how to design clear, consistent API error codes and messages by referencing HTTP status code segmentation, defining code‑message pairs, customizing user‑friendly messages, and centralizing handling to improve communication, debugging, and monitoring for backend services.

API DesignBackenderror codes
0 likes · 6 min read
Designing API Error Codes and Messages: Best Practices and Standardization
21CTO
21CTO
May 22, 2023 · Backend Development

How to Build Stable, Composable Enterprise APIs: A Practical Design Guide

This guide outlines practical steps and best‑practice recommendations for designing reusable, stable, and composable enterprise APIs, covering domain‑driven modeling, stakeholder collaboration, API specification creation, validation, tooling, and governance to ensure high‑quality, evolvable services.

API DesignAPI GovernanceEnterprise API
0 likes · 12 min read
How to Build Stable, Composable Enterprise APIs: A Practical Design Guide
MaGe Linux Operations
MaGe Linux Operations
May 14, 2023 · Backend Development

Designing Clear API Return Codes: From HTTP Status to Custom Messages

This article explains how to design consistent API return codes by leveraging HTTP status conventions, defining structured error codes with messages, personalizing user‑facing messages, and using unified handling for monitoring and alerting, ultimately reducing communication and maintenance costs.

API Designbackend developmenterror handling
0 likes · 5 min read
Designing Clear API Return Codes: From HTTP Status to Custom Messages
Architect
Architect
May 3, 2023 · Backend Development

Comprehensive Guide to Backend API Design with Spring Boot: Validation, Global Exception Handling, Unified Responses, Versioning, and Security

This article provides a step‑by‑step tutorial on building robust Spring Boot backend APIs, covering environment setup, parameter validation techniques, global exception handling, unified response structures, API version control, and security measures such as token authentication, timestamp checks, URL signing, replay protection, and HTTPS.

API DesignSpring Bootexception handling
0 likes · 27 min read
Comprehensive Guide to Backend API Design with Spring Boot: Validation, Global Exception Handling, Unified Responses, Versioning, and Security
Sohu Tech Products
Sohu Tech Products
Apr 26, 2023 · Backend Development

Designing Robust and Idempotent APIs: Principles and Practices

This article explores essential API design principles—idempotency, robustness, and security—by discussing practical techniques such as request locks, database unique constraints, Redis distributed locks, token‑based authentication, JWT, and defensive coding practices to ensure reliable, safe, and maintainable backend services.

API DesignBackendRobustness
0 likes · 36 min read
Designing Robust and Idempotent APIs: Principles and Practices
Alipay Experience Technology
Alipay Experience Technology
Mar 23, 2023 · Frontend Development

What’s New in G2 5.0? A Deep Dive into the Next‑Gen Frontend Visualization Library

G2 5.0, the latest open‑source visualization library from AntV, introduces a progressive visual grammar, richer chart types, enhanced data analysis, animation, annotation, color expressiveness, modular architecture, server‑side rendering, and a new Spec API, while outlining future work and upgrade guidance for developers.

API DesignFrontend LibraryServer-Side Rendering
0 likes · 12 min read
What’s New in G2 5.0? A Deep Dive into the Next‑Gen Frontend Visualization Library
DataFunSummit
DataFunSummit
Mar 20, 2023 · Fundamentals

Practical Naming Guidelines for Code: Principles, Rules, and Vocabulary

This article provides practical, experience‑based naming guidelines for software development, covering precision, readability, abbreviation policies, language‑specific conventions, design‑pattern naming, and a comprehensive code‑term glossary to help developers choose clear and maintainable identifiers.

API DesignBest PracticesCode style
0 likes · 40 min read
Practical Naming Guidelines for Code: Principles, Rules, and Vocabulary
MaGe Linux Operations
MaGe Linux Operations
Feb 13, 2023 · Backend Development

Why GraphQL Is the Modern Solution to REST’s API Challenges

The article explains how REST, despite its 20‑year popularity and simplicity, suffers from redundancy, coarse granularity and maintenance overhead, and shows how GraphQL’s declarative, schema‑driven approach, single endpoint and flexible data fetching address these problems while offering a versatile integration architecture and rich ecosystem.

API DesignData FetchingGraphQL
0 likes · 16 min read
Why GraphQL Is the Modern Solution to REST’s API Challenges
Efficient Ops
Efficient Ops
Feb 8, 2023 · Backend Development

Mastering RESTful API Design: Best Practices and APISIX Implementation

This article explains what RESTful APIs are, outlines their architectural constraints, shares practical design guidelines such as using nouns in URIs, proper HTTP methods, status codes, versioning strategies, and demonstrates how Apache APISIX can enforce these practices and modernize legacy APIs without changing existing code.

API DesignAPISIXHTTP methods
0 likes · 12 min read
Mastering RESTful API Design: Best Practices and APISIX Implementation
Java High-Performance Architecture
Java High-Performance Architecture
Jan 24, 2023 · Backend Development

How to Build Highly Available Backend APIs: 10 Essential Design Principles

This article explains why high availability is crucial for backend services and outlines ten practical design principles—including dependency control, avoiding single points, load balancing, isolation, rate limiting, circuit breaking, async processing, degradation, gray release, and chaos engineering—to help developers create resilient APIs.

API DesignBackendfault tolerance
0 likes · 10 min read
How to Build Highly Available Backend APIs: 10 Essential Design Principles
Architects Research Society
Architects Research Society
Jan 13, 2023 · Backend Development

Backend for Frontend (BFF) Pattern: Designing Single‑Purpose Edge Services for User Interfaces

The article explains how the Backend for Frontend (BFF) pattern creates dedicated, lightweight server‑side APIs for each UI type—desktop web, mobile, or third‑party—allowing teams to tailor functionality, reduce coupling, aggregate micro‑service calls, and improve autonomy while addressing performance, scaling, and organizational concerns.

API DesignBFFBackend
0 likes · 20 min read
Backend for Frontend (BFF) Pattern: Designing Single‑Purpose Edge Services for User Interfaces
macrozheng
macrozheng
Dec 12, 2022 · Backend Development

Designing Secure, Reliable APIs: Signatures, Encryption, Rate Limiting & More

Learn how to design robust, secure API interfaces by implementing signatures, encryption, IP whitelists, rate limiting, parameter validation, unified responses, exception handling, logging, idempotency, request size limits, load testing, asynchronous processing, data masking, and comprehensive documentation to ensure stability and safety.

API Designdocumentationidempotency
0 likes · 15 min read
Designing Secure, Reliable APIs: Signatures, Encryption, Rate Limiting & More
Su San Talks Tech
Su San Talks Tech
Dec 12, 2022 · Backend Development

Designing Secure and Robust APIs: Signatures, Encryption, Rate Limiting, and More

This article outlines essential practices for building secure, reliable API interfaces—including request signing, data encryption, IP whitelisting, rate limiting, parameter validation, unified responses, exception handling, logging, idempotency, payload limits, performance testing, asynchronous processing, data masking, and comprehensive documentation—to help developers meet safety, stability, and maintainability requirements.

API DesignRate Limitingencryption
0 likes · 15 min read
Designing Secure and Robust APIs: Signatures, Encryption, Rate Limiting, and More
Code Ape Tech Column
Code Ape Tech Column
Nov 23, 2022 · Backend Development

Best Practices for Consistent Backend API Design

This guide presents a concise set of best‑practice rules for designing consistent, resource‑oriented RESTful APIs, covering naming conventions, URL structures, HTTP methods, versioning, pagination, security, monitoring, and documentation to improve developer experience and system reliability.

API DesignBackendHTTP methods
0 likes · 9 min read
Best Practices for Consistent Backend API Design
Top Architect
Top Architect
Nov 19, 2022 · Backend Development

Design and Implementation of an Open API Token Authentication System with Spring Boot

This article explains how to design an open API authentication mechanism by creating app credentials, storing them in a MySQL table, generating short‑lived access tokens with a utility class, exposing a token endpoint, and securing all /openApi/* routes with a Spring interceptor, complete with code examples.

API DesignJavaSpring Boot
0 likes · 9 min read
Design and Implementation of an Open API Token Authentication System with Spring Boot
DataFunSummit
DataFunSummit
Nov 16, 2022 · Artificial Intelligence

Designing Effective APIs for AI Open‑Source Software

This article explains why API design is crucial for AI open‑source projects, outlines the new challenges faced, presents three fundamental design principles with concrete examples, and offers practical guidance on documentation, error handling, and evaluation to create user‑friendly, scalable AI software ecosystems.

AI+SoftwareAPI DesignSoftware Engineering
0 likes · 11 min read
Designing Effective APIs for AI Open‑Source Software
Top Architect
Top Architect
Oct 28, 2022 · Backend Development

Guidelines for Front‑End/Back‑End Separation and API Specification

The article explains why front‑end and back‑end should be separated, outlines the challenges of integration, describes the responsibilities and development process for a clean API contract, and provides detailed request/response specifications with code examples for building a maintainable SPA architecture.

API DesignBackendSPA
0 likes · 11 min read
Guidelines for Front‑End/Back‑End Separation and API Specification
Rare Earth Juejin Tech Community
Rare Earth Juejin Tech Community
Oct 20, 2022 · Backend Development

Designing a Unified Base Package for Backend Projects: Maven Dependencies, Standardized Response Body, and Data Object Segmentation

This article explains how to construct a reusable base package for backend systems by defining Maven dependency guidelines, a unified response body with business codes, proper data object layers such as PO, BO, DTO, VO, and pagination utilities, while illustrating the concepts with concrete Java code examples.

API DesignDDDDTO
0 likes · 11 min read
Designing a Unified Base Package for Backend Projects: Maven Dependencies, Standardized Response Body, and Data Object Segmentation
Architecture Digest
Architecture Digest
Sep 30, 2022 · Backend Development

Best Practices for Designing a Good API

This article explains why well‑designed APIs are essential, covering data modeling, resource hierarchy, naming conventions, RESTful principles, CRUD operations, versioning strategies, and pagination techniques, and provides concrete examples and guidelines to help developers create robust, maintainable, and developer‑friendly APIs.

API DesignBackendREST
0 likes · 7 min read
Best Practices for Designing a Good API
21CTO
21CTO
Sep 27, 2022 · Backend Development

Mastering API Design: From Basics to Rate Limiting, Versioning, and Security

This article shares practical insights on API design, covering fundamentals, rate limiting, version management, security considerations, and inter‑team integration, illustrated with code snippets and diagrams to help developers build clear, standardized, and robust backend interfaces.

API DesignRate Limitingsecurity
0 likes · 17 min read
Mastering API Design: From Basics to Rate Limiting, Versioning, and Security
ITFLY8 Architecture Home
ITFLY8 Architecture Home
Sep 25, 2022 · Backend Development

Master System Design Discussions: From Requirements to Scalable Architecture

This guide walks you through structuring a system‑design discussion—from clarifying functional and non‑functional requirements, mapping user flows and API calls, to outlining high‑level architecture, scaling strategies, and drafting a database schema—using a Twitter‑like example to illustrate each step.

API DesignSystem Designdatabase-schema
0 likes · 9 min read
Master System Design Discussions: From Requirements to Scalable Architecture
Top Architect
Top Architect
Sep 24, 2022 · Frontend Development

Guidelines for Frontend‑Backend Separation and API Specification

This article explains why and how to separate frontend and backend responsibilities, outlines the evolution from MVC to SPA architectures, and provides detailed API request and response conventions—including JSON formats, pagination, and special field handling—to improve collaboration and reduce integration effort.

API DesignBackendSPA
0 likes · 10 min read
Guidelines for Frontend‑Backend Separation and API Specification
政采云技术
政采云技术
Sep 6, 2022 · Frontend Development

Front‑End and Back‑End Collaboration Guidelines and Best Practices

This article presents a comprehensive set of front‑end and back‑end collaboration standards, covering why specifications are needed, the recommended workflow, detailed API conventions, common pitfalls with concrete solutions, and the measurable benefits of adopting a unified development protocol.

API DesignSoftware Engineeringcollaboration
0 likes · 13 min read
Front‑End and Back‑End Collaboration Guidelines and Best Practices
IT Architects Alliance
IT Architects Alliance
Aug 15, 2022 · R&D Management

Essential Practices for Effective Engineering Projects and R&D Management

This article outlines comprehensive guidelines for keeping customers happy, managing projects, designing robust APIs, conducting thorough code reviews, shaping strategic direction, ensuring observability, and fostering research, all aimed at building resilient and high‑performing engineering teams.

API DesignCode ReviewR&D management
0 likes · 12 min read
Essential Practices for Effective Engineering Projects and R&D Management
IT Architects Alliance
IT Architects Alliance
Aug 9, 2022 · Backend Development

Mastering Consistent API Design: 22 Essential Best Practices

This guide presents 22 practical rules for designing clean, consistent RESTful APIs—including resource-oriented URLs, kebab‑case paths, camelCase parameters, proper use of HTTP verbs, versioning, pagination, field selection, CORS, security, and monitoring—to help developers avoid common pitfalls and improve API usability.

API DesignHTTP methodsREST
0 likes · 9 min read
Mastering Consistent API Design: 22 Essential Best Practices
Top Architect
Top Architect
Aug 8, 2022 · Backend Development

Best Practices for Designing Consistent Backend APIs

This article presents a concise yet comprehensive guide to RESTful API design, covering resource-oriented naming, kebab‑case URLs, camelCase parameters, proper use of HTTP verbs, versioning, health/metrics endpoints, pagination, field selection, authentication headers, CORS, error handling, and golden rules for creating clean, maintainable backend services.

API DesignHTTPREST
0 likes · 9 min read
Best Practices for Designing Consistent Backend APIs
Java Backend Technology
Java Backend Technology
Jul 22, 2022 · Backend Development

Why Unified API Responses Matter: Mastering Spring Boot Controllers and AOP

This article explains common pitfalls in Java API design—such as inconsistent return formats, missing error handling, and inappropriate parameters—and demonstrates how a unified ResultBean, strict controller conventions, and AOP logging can dramatically improve code readability, maintainability, and error management in Spring Boot projects.

AOPAPI DesignJava
0 likes · 10 min read
Why Unified API Responses Matter: Mastering Spring Boot Controllers and AOP
ITPUB
ITPUB
Jul 17, 2022 · Backend Development

36 Essential Tips for Designing Robust Backend APIs

This comprehensive guide presents 36 practical recommendations for backend engineers, covering parameter validation, compatibility, extensibility, idempotency, error handling, logging, performance optimization, caching, rate limiting, security, transaction management, and clear communication to help design reliable, maintainable, and scalable service interfaces.

API DesignBackendValidation
0 likes · 27 min read
36 Essential Tips for Designing Robust Backend APIs
Top Architect
Top Architect
Jun 22, 2022 · Backend Development

Designing API Error Codes and Messages: Best Practices

This article explains how to design clear and consistent API error codes and messages by borrowing the segmentation logic of HTTP status codes, defining code‑message pairs, providing personalized user‑facing messages, and centralizing handling for monitoring and alerting, ultimately reducing communication and maintenance costs.

API Designerror codeshttp status
0 likes · 6 min read
Designing API Error Codes and Messages: Best Practices
macrozheng
macrozheng
Jun 21, 2022 · Backend Development

Why Enums Can Break RPC Calls and How to Avoid Them

An online service threw an IllegalArgumentException because a downstream system added a new enum constant without notifying dependent services, leading to deserialization failures in RPC calls; the article explains the root cause, JSON serialization behavior, and recommends using strings instead of enums for API parameters and return values.

API DesignEnumJava
0 likes · 10 min read
Why Enums Can Break RPC Calls and How to Avoid Them
Bilibili Tech
Bilibili Tech
Jun 3, 2022 · Backend Development

Bilibili Open Platform Video Submission Workflow and Upload Token Design

Bilibili’s Open Platform streamlines video uploads by replacing a complex multi‑parameter flow with a single upload_token that encapsulates authentication and file metadata, enabling chunked uploads, merging, and manuscript submission via a JavaScript SDK, which cuts integration errors and speeds first‑time submissions by over sixty percent.

API DesignBilibiliJS SDK
0 likes · 12 min read
Bilibili Open Platform Video Submission Workflow and Upload Token Design
Top Architect
Top Architect
May 26, 2022 · Backend Development

Designing API Return Codes and Messages: Best Practices for Backend Services

This article explains how to design clear, consistent API return codes and messages by referencing HTTP status codes, defining code‑message pairs, supporting personalized messages for different clients, and using unified handling for monitoring and alerting, ultimately improving communication and maintenance costs.

API DesignHTTP status codeserror codes
0 likes · 6 min read
Designing API Return Codes and Messages: Best Practices for Backend Services
Architecture Digest
Architecture Digest
Apr 19, 2022 · Backend Development

Best Practices for Designing HTTP APIs: Status Codes, JSON Payloads, Resource Naming, and Error Handling

This guide outlines comprehensive backend API design recommendations, covering appropriate HTTP status codes, JSON request bodies, unique resource identifiers, timestamp formats, consistent URL structures, nested relationships, error message schemas, caching, pagination, versioning, security, and clear documentation with executable examples.

API DesignBackendHTTP
0 likes · 13 min read
Best Practices for Designing HTTP APIs: Status Codes, JSON Payloads, Resource Naming, and Error Handling
IT Architects Alliance
IT Architects Alliance
Mar 24, 2022 · Backend Development

Understanding REST and Best Practices for RESTful API Design

This article explains the origins of REST, breaks down its core concepts of resources, representations, and state transfer, and provides comprehensive guidelines for designing clean, secure, and versioned RESTful APIs, including URL conventions, HTTP verbs, status codes, and authentication practices.

API DesignCRUDHTTP
0 likes · 8 min read
Understanding REST and Best Practices for RESTful API Design
Top Architect
Top Architect
Mar 24, 2022 · Backend Development

Understanding REST and Best Practices for RESTful API Design

This article explains the origins of REST, breaks down its core concepts of resources, representations, and state transfer, and provides comprehensive guidelines for designing clean, versioned, and secure RESTful APIs, including URL conventions, HTTP verbs, status codes, and authentication.

API DesignHTTPREST
0 likes · 9 min read
Understanding REST and Best Practices for RESTful API Design
MaGe Linux Operations
MaGe Linux Operations
Mar 12, 2022 · Backend Development

Mastering RESTful API Design in Go: 12 Essential Best Practices

This article revisits RESTful API design using Go Web, covering twelve practical guidelines such as JSON usage, verb‑free and pluralized paths, hierarchical resources, pagination, unified response formats, proper HTTP status codes, versioning, HTTPS, and documentation to help developers build clear, consistent, and secure APIs.

API DesignBackendGin
0 likes · 9 min read
Mastering RESTful API Design in Go: 12 Essential Best Practices
Code Ape Tech Column
Code Ape Tech Column
Feb 28, 2022 · Backend Development

Best Practices for Consistent Backend API Design

This article presents a concise set of best‑practice guidelines for designing consistent, resource‑oriented RESTful APIs, covering naming conventions, URL structures, HTTP methods, parameter handling, versioning, monitoring, security, error handling, and documentation tools.

API DesignBackendHTTP methods
0 likes · 11 min read
Best Practices for Consistent Backend API Design
Java Interview Crash Guide
Java Interview Crash Guide
Feb 23, 2022 · Backend Development

Designing Clear API Return Codes: Lessons from HTTP Status Codes

This article explains why consistent API return‑code design matters, illustrates how HTTP status code segmentation can inspire better error codes, and shows how to pair codes with customizable messages for both developers and end‑users to improve communication and maintenance efficiency.

API DesignHTTP status codeserror handling
0 likes · 4 min read
Designing Clear API Return Codes: Lessons from HTTP Status Codes
Java Interview Crash Guide
Java Interview Crash Guide
Feb 22, 2022 · Backend Development

Ensuring API Idempotency: Prevent Duplicate Requests in Scalable Systems

Idempotency ensures that repeated API calls produce the same result, preventing duplicate processing in high‑traffic systems; this article explains why it matters, typical duplicate request scenarios, and a practical implementation using client‑generated identifiers to cache and filter repeated submissions.

API Designidempotencymicroservices
0 likes · 4 min read
Ensuring API Idempotency: Prevent Duplicate Requests in Scalable Systems
21CTO
21CTO
Feb 17, 2022 · Backend Development

10 Essential API Design Rules for Consistent Backend Services

This guide presents a concise set of best‑practice rules for designing consistent, RESTful backend APIs—including naming conventions, URL structures, HTTP methods, versioning, pagination, security, and documentation tools—to help developers create clear, maintainable, and user‑friendly services.

API DesignBackendHTTP methods
0 likes · 9 min read
10 Essential API Design Rules for Consistent Backend Services
Top Architect
Top Architect
Feb 15, 2022 · Backend Development

Best Practices for Designing Consistent Backend APIs

This article presents a comprehensive set of best‑practice guidelines for designing clean, consistent, and secure RESTful backend APIs, covering URL naming conventions, parameter styles, resource naming, versioning, pagination, authentication, error handling, and documentation tools.

API DesignHTTPREST
0 likes · 10 min read
Best Practices for Designing Consistent Backend APIs
DataFunTalk
DataFunTalk
Feb 9, 2022 · Artificial Intelligence

Designing Effective APIs for AI Open‑Source Software

This article explains why API design is crucial for AI open-source software, outlines new challenges, presents basic design principles, and offers practical guidelines, examples, and best practices to create user-friendly, stable, and extensible interfaces that lower learning costs and foster ecosystem growth.

AIAPI DesignSoftware Engineering
0 likes · 10 min read
Designing Effective APIs for AI Open‑Source Software
IT Architects Alliance
IT Architects Alliance
Feb 7, 2022 · Backend Development

Best Practices for Consistent Backend API Design

This guide presents a concise set of best‑practice rules for designing consistent, RESTful backend APIs—including naming conventions, versioning, pagination, security, monitoring, and error handling—to improve developer experience and maintainability across microservice architectures.

API DesignHTTP methodsREST
0 likes · 10 min read
Best Practices for Consistent Backend API Design
Architect
Architect
Feb 5, 2022 · Backend Development

Best Practices for Designing Consistent RESTful APIs

This article presents a concise, step‑by‑step guide to designing clean, consistent RESTful APIs, covering resource naming, URL conventions, HTTP methods, versioning, pagination, field selection, security, monitoring, error handling, and documentation tools, with concrete code examples for each rule.

API DesignHTTP methodsREST
0 likes · 10 min read
Best Practices for Designing Consistent RESTful APIs
Architecture Digest
Architecture Digest
Jan 27, 2022 · Backend Development

Designing API Error Codes and Result Codes: Best Practices

This article explains why a well‑designed API error‑code system—using consistent numeric or string codes, clear messages, HTTP‑status‑like segmentation, personalized user messages, and unified handling for monitoring—reduces communication overhead, simplifies maintenance, and improves overall backend reliability.

API Designerror codeshttp status
0 likes · 6 min read
Designing API Error Codes and Result Codes: Best Practices
Architect
Architect
Jan 23, 2022 · Backend Development

Designing Consistent API Return Codes: Lessons from HTTP Status Codes

The article explains why a well‑designed API return‑code system—modeled after HTTP status codes, with clear numeric ranges, descriptive messages, and personalized user messages—reduces communication overhead, simplifies maintenance, and enables effective monitoring and alerting for backend services.

API DesignHTTP status codesbackend development
0 likes · 6 min read
Designing Consistent API Return Codes: Lessons from HTTP Status Codes
21CTO
21CTO
Jan 10, 2022 · Backend Development

Mastering REST vs RESTful: Key Differences, Best Practices, and Future Trends

This comprehensive guide explains the origins and definitions of REST and RESTful, outlines core architectural constraints, compares terminology, presents best‑practice API design patterns—including URI conventions, HTTP methods, error handling, filtering, pagination, versioning, and health checks—while evaluating the future role of REST versus GraphQL.

API DesignBest PracticesFiltering
0 likes · 30 min read
Mastering REST vs RESTful: Key Differences, Best Practices, and Future Trends
Top Architect
Top Architect
Dec 28, 2021 · Backend Development

Using @PathVariable for RESTful API Parameters in Spring MVC

This article explains how to use the @PathVariable annotation in Spring MVC to handle required and optional parameters in RESTful URLs, illustrates the syntax with image-based examples, discusses the complexity of multiple parameters, and advises using POST for more intricate cases, while also offering promotional links and giveaways.

API DesignJavaPathVariable
0 likes · 4 min read
Using @PathVariable for RESTful API Parameters in Spring MVC
21CTO
21CTO
Dec 26, 2021 · Backend Development

REST vs gRPC: Which API Architecture Wins for Modern Microservices?

This article explains what APIs are, introduces RPC and gRPC, compares them with REST across protocols, data formats, performance, code generation, and browser support, and offers guidance on when to choose gRPC or REST for microservice and mobile applications.

API DesignHTTP/2Protocol Buffers
0 likes · 11 min read
REST vs gRPC: Which API Architecture Wins for Modern Microservices?