BestHub
Sign in
Tagged articles

API Design

312 articles · Page 3 of 4
Top Architect
Top Architect
Sep 27, 2021 · Backend Development

Best Practices for Designing, Securing and Scaling Java Backend APIs

This article explains how to design robust Java backend APIs, covering interface definition, request/response formats, error handling, token generation, digital signing, interceptor chains, rate limiting, HTTPS migration, and strategies for high concurrency and high availability such as load balancing, clustering and caching.

API DesignHigh AvailabilitySpring Boot
0 likes · 16 min read
Best Practices for Designing, Securing and Scaling Java Backend APIs
Tencent IMWeb Frontend Team
Tencent IMWeb Frontend Team
Aug 30, 2021 · Backend Development

Essential Nest.js Best Practices for Scalable Backend Development

This guide shares practical Nest.js tips—including global API prefixes, modular folder structures, DTO usage, Data Mapper over Active Record, relative imports, data exclusion, getters, and barrel exports—to help developers build maintainable, version‑compatible backend services.

API DesignCode OrganizationDTO
0 likes · 7 min read
Essential Nest.js Best Practices for Scalable Backend Development
IT Architects Alliance
IT Architects Alliance
Jul 11, 2021 · Backend Development

10 Best Practices for Designing a Robust Microservices Architecture

This article explains how adopting ten essential microservice best practices—such as single responsibility, independent data stores, asynchronous communication, circuit breakers, API gateways, backward‑compatible APIs, versioning, dedicated infrastructure, independent release pipelines, and organizational efficiency—helps build a loosely‑coupled, scalable, and maintainable backend system.

API DesignMicroservicesarchitecture
0 likes · 9 min read
10 Best Practices for Designing a Robust Microservices Architecture
Top Architect
Top Architect
Jun 24, 2021 · Backend Development

Designing Idempotent APIs and Global Unique ID Strategies

This article explains the concept of API idempotency, why it is needed, practical design approaches, and how to generate globally unique identifiers using methods such as UUID and Snowflake to ensure reliable, high‑performance backend services.

API DesignIdempotencybackend
0 likes · 8 min read
Designing Idempotent APIs and Global Unique ID Strategies
Code Ape Tech Column
Code Ape Tech Column
Jun 15, 2021 · Backend Development

How to Build Robust, High‑Concurrency APIs: Design, Security, and Scaling Tips

This article outlines practical guidelines for designing and implementing enterprise‑grade APIs, covering request/response definitions, unified error handling, interceptor chains, token‑based authentication, rate limiting, load balancing, clustering, caching, and strategies for achieving high concurrency and high availability.

API DesignException HandlingLoad Balancing
0 likes · 18 min read
How to Build Robust, High‑Concurrency APIs: Design, Security, and Scaling Tips
Su San Talks Tech
Su San Talks Tech
Jun 7, 2021 · Backend Development

Why Region IDs Break OpenAPI Integrations and How to Design Resilient Solutions

This article examines the challenges of synchronizing enterprise data across systems when region identifiers differ, explores several technical approaches—including persisting local tables, name‑based and code‑based lookups, snapshot storage, manual updates, and flexible API fields—and concludes with a pragmatic, business‑centric solution for reliable integration.

API DesignBackend IntegrationData Consistency
0 likes · 14 min read
Why Region IDs Break OpenAPI Integrations and How to Design Resilient Solutions
IT Architects Alliance
IT Architects Alliance
Jun 6, 2021 · Backend Development

Understanding the Richardson Maturity Model and Best Practices for REST API Design

This article explains the Richardson Maturity Model for REST, illustrates each level with a hospital appointment example—including HTTP request/response code snippets and HATEOAS links—and then outlines practical REST API design guidelines such as using nouns, proper HTTP verbs, pagination, versioning, and comprehensive status‑code handling.

API DesignHTTPMaturity Model
0 likes · 15 min read
Understanding the Richardson Maturity Model and Best Practices for REST API Design
21CTO
21CTO
Mar 19, 2021 · Backend Development

Why GraphQL Beats REST for Modern APIs: Benefits and Code Examples

This article compares REST and GraphQL, highlighting REST's issues like excessive round‑trips, over‑/under‑fetching, and rigidity, and shows how GraphQL solves them with single‑request queries and flexible data selection, while offering guidance on when to choose each approach.

API DesignGraphQLREST
0 likes · 6 min read
Why GraphQL Beats REST for Modern APIs: Benefits and Code Examples
Alibaba Cloud Developer
Alibaba Cloud Developer
Mar 19, 2021 · Fundamentals

What Core Design Principles Drive Reliable Financial Software?

This article outlines practical software design principles—layered architecture, single responsibility, data redundancy, security, concurrency, and API design—derived from real‑world financial platform projects, showing how concrete rules help avoid coupling, data loss, and performance pitfalls.

API Designarchitecture principlesbackend development
0 likes · 12 min read
What Core Design Principles Drive Reliable Financial Software?
Programmer DD
Programmer DD
Feb 27, 2021 · Backend Development

Why Generic API Error Messages Hurt Users and How to Handle Exceptions Properly

The article critiques returning vague third‑party API error messages, explains why swallowing exceptions and omitting stack traces make debugging hard, and advises providing user‑friendly messages and proper logging to improve reliability and maintainability of backend services.

API Designerror handlingexception logging
0 likes · 3 min read
Why Generic API Error Messages Hurt Users and How to Handle Exceptions Properly
21CTO
21CTO
Feb 17, 2021 · Backend Development

Mastering API Design for Microservices: Principles, Pitfalls, and Best Practices

Effective API design is crucial for microservice architectures, reducing communication overhead, preventing API decay, and ensuring scalability; this article outlines common pitfalls, core design principles such as simplicity, focus, extensibility, compatibility, thorough testing, and documentation to help developers build robust, maintainable services.

API DesignMicroservicesbackend development
0 likes · 11 min read
Mastering API Design for Microservices: Principles, Pitfalls, and Best Practices
JavaScript
JavaScript
Jan 27, 2021 · Backend Development

Which API Response Format Is Best: Include Empty B or Omit It?

The discussion compares two API response designs—always returning an empty array for field B versus omitting B when it has no data—and evaluates which approach provides clearer contracts and easier handling for front‑end developers.

API DesignFrontendbackend
0 likes · 1 min read
Which API Response Format Is Best: Include Empty B or Omit It?
21CTO
21CTO
Jan 24, 2021 · Backend Development

Why GraphQL Is Replacing REST: A Deep Dive into Modern API Design

This article examines the limitations of traditional REST APIs, explains how GraphQL offers a more flexible, efficient, and declarative approach to data fetching, outlines its core concepts, schema design, type system, and deployment architectures, and provides guidance on integrating GraphQL into existing backend and frontend ecosystems.

API DesignGraphQLREST
0 likes · 17 min read
Why GraphQL Is Replacing REST: A Deep Dive into Modern API Design
Top Architect
Top Architect
Jan 20, 2021 · Backend Development

Key Practices and Considerations in Microservice Architecture Design

The article explores practical design principles for microservice architecture, covering core concepts, team and database partitioning, API granularity, domain‑composed services, gateway strategies, shared JAR dependencies, decoupling techniques, and change‑impact analysis to guide robust backend system development.

API DesignBackend ArchitectureGateway
0 likes · 16 min read
Key Practices and Considerations in Microservice Architecture Design
21CTO
21CTO
Jan 14, 2021 · Backend Development

Why GraphQL Is the Future of API Design: Overcoming REST’s Limitations

This article explains how REST’s coarse‑grained, redundant interfaces hinder front‑end efficiency, then introduces GraphQL as a flexible, declarative alternative that automatically adapts to changing data requirements, reduces API proliferation, and streamlines backend‑frontend communication.

API DesignGraphQLREST
0 likes · 16 min read
Why GraphQL Is the Future of API Design: Overcoming REST’s Limitations
Architect's Tech Stack
Architect's Tech Stack
Dec 28, 2020 · Backend Development

Designing a Unified API Response Structure with Result Wrapper and @ResponseResult in Java Backend Development

This article explains how to design a consistent JSON response format for micro‑service APIs, introduces a Result wrapper class with status code, message and data, and shows how to use a custom @ResponseResult annotation together with Spring's ResponseBodyAdvice to automatically wrap controller outputs while addressing common pitfalls and optimization opportunities.

API Designbackendjava
0 likes · 8 min read
Designing a Unified API Response Structure with Result Wrapper and @ResponseResult in Java Backend Development
Architect's Journey
Architect's Journey
Dec 24, 2020 · Backend Development

Comparing Two Feign Usage Patterns for Elegant Producer‑Consumer Communication in Microservices

The article examines two ways to define Feign interfaces in a microservice architecture—having the service producer define the Feign client (SPI) versus letting the service consumer define it (API)—and compares their constraints, flexibility, dependency management, and impact on development workflow.

API DesignFeignMicroservices
0 likes · 7 min read
Comparing Two Feign Usage Patterns for Elegant Producer‑Consumer Communication in Microservices
Java Architect Essentials
Java Architect Essentials
Dec 9, 2020 · Backend Development

Designing a Unified API Response Structure for a Java E‑Commerce Platform

This article explains how to design a unified API response format in a Java-based fresh‑food e‑commerce system, covering overall architecture, JSON response schema, status‑code conventions, Result wrapper class, controller refactoring, custom annotations, and interceptor implementation to achieve clean and maintainable backend responses.

API DesignRESTannotations
0 likes · 8 min read
Designing a Unified API Response Structure for a Java E‑Commerce Platform
vivo Internet Technology
vivo Internet Technology
Dec 9, 2020 · Backend Development

vivo Mall Consignment Business: Heterogeneous System Integration Architecture and Practice

The article details vivo Mall’s heterogenous system integration architecture for a consignment model with NetEase Yanxuan, describing platform selection criteria, an API‑gateway‑style design with modular routing, adapters, unified callbacks and configuration, and the integration of product and order centers, while outlining plans for proprietary API standards to lower future integration costs.

API Designadapter patternconsignment business
0 likes · 10 min read
vivo Mall Consignment Business: Heterogeneous System Integration Architecture and Practice
Programmer DD
Programmer DD
Nov 20, 2020 · Fundamentals

15 Must‑Know Java API Design Tips from Effective Java

This article distills key recommendations from Joshua Bloch’s Effective Java, covering static factory methods, builder patterns, singleton protection, memory management, and API design conventions, providing concise examples and practical guidance to help Java developers write clearer, more efficient, and safer code.

API DesignEffective Javabest practices
0 likes · 23 min read
15 Must‑Know Java API Design Tips from Effective Java
DevOps
DevOps
Nov 2, 2020 · Fundamentals

Comprehensive Guide to API Design, Performance, and Developer Challenges

This article explores the pervasive role of APIs in software development, contrasting good and bad designs, outlining empirical design principles, performance classifications, testing strategies, and cultural factors that affect API usability, while offering practical advice for developers to create robust, well‑documented interfaces.

API Designdeveloper experiencesoftware performance
0 likes · 37 min read
Comprehensive Guide to API Design, Performance, and Developer Challenges
Top Architect
Top Architect
Oct 24, 2020 · Backend Development

Designing a Unified API Response Format for Java Backend Services

This article explains how to create a consistent JSON response structure for Java backend APIs, covering status‑code conventions, a Result wrapper class, static helper methods, a custom @ResponseResult annotation, response‑body advice, and tips for simplifying controller code and handling exceptions.

API DesignSpringannotations
0 likes · 7 min read
Designing a Unified API Response Format for Java Backend Services
IT Architects Alliance
IT Architects Alliance
Sep 29, 2020 · Big Data

How Qualitis Ensures High‑Availability Data Quality Monitoring on Big Data Platforms

Qualitis is a big‑data‑platform‑based data‑quality‑management service that defines, detects, and reports data‑set quality issues, featuring idempotent backend services, load‑balanced high‑availability, Zookeeper‑coordinated process synchronization, thread‑pool throttling, and clearly separated internal and external APIs.

API DesignBig DataHigh Availability
0 likes · 6 min read
How Qualitis Ensures High‑Availability Data Quality Monitoring on Big Data Platforms
Architecture Digest
Architecture Digest
Sep 1, 2020 · Backend Development

A Comparative Overview of Popular REST API Tools

This article surveys a wide range of REST API tools—covering API definition, testing, monitoring, publishing, and centralized management—highlighting their key features, supported languages, integration capabilities, and suitability for teams of different sizes and project requirements.

API DesignAPI ManagementAPI testing
0 likes · 8 min read
A Comparative Overview of Popular REST API Tools
DevOps
DevOps
Aug 21, 2020 · Backend Development

API Design Principles and Checklist for Microservices

Effective API design in microservices requires platform independence, reliability, appropriate RESTful maturity, avoiding simple wrappers, ensuring separation of concerns, exhaustive and independent endpoints, proper versioning, consistent naming, and security measures, all of which are detailed alongside practical examples and a comprehensive review checklist.

API DesignMicroservicesRESTful
0 likes · 11 min read
API Design Principles and Checklist for Microservices
Qunar Tech Salon
Qunar Tech Salon
Aug 19, 2020 · Backend Development

Applying GraphQL to Solve Data Customization and Multi‑Request Issues in Qunar's Node BFF Service

This article analyzes the shortcomings of the existing RESTful Node BFF service for Qunar's domestic hotel platform—such as data customization difficulty, manual documentation, and redundant fields—and demonstrates how adopting GraphQL can provide precise data fetching, automatic schema documentation, and unified request composition to improve development efficiency and system performance.

API DesignData CustomizationGraphQL
0 likes · 19 min read
Applying GraphQL to Solve Data Customization and Multi‑Request Issues in Qunar's Node BFF Service
Programmer DD
Programmer DD
Jul 23, 2020 · Backend Development

Why Consumers Should Lead API Design: Lessons from Real-World Mistakes

This article examines common pitfalls in API design, argues that the consumer of an interface should drive its design, and presents concrete examples and best‑practice recommendations for structuring endpoints, meta data, and choosing appropriate communication protocols.

API DesignRESTbackend development
0 likes · 15 min read
Why Consumers Should Lead API Design: Lessons from Real-World Mistakes
Programmer DD
Programmer DD
Jul 21, 2020 · Backend Development

Why GraphQL Beats REST: A Deep Dive into Modern API Design

This article explains the limitations of traditional REST APIs, introduces GraphQL as a flexible alternative, compares their architectures, and outlines how GraphQL’s schema‑driven approach simplifies data fetching, reduces redundancy, and integrates with existing backend services.

API DesignGraphQLREST
0 likes · 16 min read
Why GraphQL Beats REST: A Deep Dive into Modern API Design
Top Architect
Top Architect
Jul 19, 2020 · Backend Development

Best Practices for Designing RESTful APIs

This article outlines essential RESTful API design principles, covering clear URL structures, proper use of HTTP verbs, precise status codes, appropriate response formats, and the inclusion of hypermedia links to create intuitive, maintainable, and standards‑compliant web services.

API DesignHTTPRESTful
0 likes · 11 min read
Best Practices for Designing RESTful APIs
JavaEdge
JavaEdge
Jul 10, 2020 · Fundamentals

Why Static Factory Methods Outshine Constructors in Java

This article explains how static factory methods improve readability, performance, and flexibility compared to public constructors, covering benefits such as named creation, instance reuse, subtype returns, service‑provider frameworks, as well as drawbacks like limited inheritance and discoverability, and offers naming conventions and real‑world Java examples.

API DesignDesign PatternsStatic Factory
0 likes · 10 min read
Why Static Factory Methods Outshine Constructors in Java
Architecture Digest
Architecture Digest
Jul 8, 2020 · Backend Development

Understanding GraphQL: Advantages Over REST and Core Concepts

This article explains the limitations of traditional REST APIs, introduces GraphQL as a flexible alternative, and details its core concepts, type system, server‑client architectures, deployment options, and popular tools and services for modern backend development.

API DesignData ModelingGraphQL
0 likes · 14 min read
Understanding GraphQL: Advantages Over REST and Core Concepts
Alibaba Cloud Developer
Alibaba Cloud Developer
Jun 29, 2020 · Backend Development

Designing Effective Error Codes: Principles, Standards, and Best Practices

This article explores the principles and practical guidelines for designing error codes, comparing log‑oriented and external‑facing standards, analyzing numeric versus alphanumeric formats, and presenting recommended structures to improve traceability, memorability, and cross‑team communication in modern backend systems.

API DesignStandardizationerror codes
0 likes · 12 min read
Designing Effective Error Codes: Principles, Standards, and Best Practices
58 Tech
58 Tech
Jun 29, 2020 · Backend Development

Design and Evolution of an Intelligent Lending API Platform

This article details the end‑to‑end design, iterative evolution, and technical architecture of an intelligent lending API platform, covering workflow abstraction, service decomposition, security mechanisms, monitoring, and performance optimizations that enable scalable, reliable integration with multiple financial institutions.

API DesignMicroservicesfinancial technology
0 likes · 14 min read
Design and Evolution of an Intelligent Lending API Platform
Architecture Digest
Architecture Digest
Apr 26, 2020 · Backend Development

RESTful API Design Best Practices and Detailed Guidelines

This article explains essential RESTful API design details—including URL conventions, HTTP verb usage, status‑code precision, proper JSON responses, and HATEOAS linking—to help developers create clear, consistent, and user‑friendly web APIs.

API DesignHTTPRESTful
0 likes · 10 min read
RESTful API Design Best Practices and Detailed Guidelines
21CTO
21CTO
Apr 11, 2020 · Backend Development

Mastering REST API Parameters: Best Practices for Query Strings

This article explains the best practices for using parameters and query strings in REST API design, covering pagination, parameterization concepts, HTTP methods, headers, caching, and authorization, and provides guidance on choosing the right approach to create efficient, stateless, and scalable APIs.

API DesignHTTPREST API
0 likes · 5 min read
Mastering REST API Parameters: Best Practices for Query Strings
JD Retail Technology
JD Retail Technology
Mar 26, 2020 · Backend Development

Design and Architecture of an Algorithm Business Platform for Rapid Online Service Development

The article details the design principles, modular architecture, and engineering optimizations of a backend algorithm platform that uses APIs, micro‑services, and asynchronous processing to enable fast, reliable, and scalable online algorithm services, including recall, ranking, metadata, feature reporting, and A/B testing.

AB testingAPI DesignAlgorithm Platform
0 likes · 9 min read
Design and Architecture of an Algorithm Business Platform for Rapid Online Service Development
Full-Stack Internet Architecture
Full-Stack Internet Architecture
Mar 22, 2020 · Backend Development

API Design Specification Guidelines for Backend Development

This article provides comprehensive API design guidelines covering routing naming conventions, request methods, parameter structures, security measures, response formats, signature design, logging platform setup, and idempotency strategies to help backend developers create consistent and reliable interfaces.

API DesignIdempotencyREST
0 likes · 6 min read
API Design Specification Guidelines for Backend Development
Programmer DD
Programmer DD
Jan 2, 2020 · Backend Development

Why Do Some Developers Hate Using Enums in API Design?

The article examines why enums, while type‑safe and convenient for input parameters, are often criticized in API return values due to their lack of extensibility and the risk of deserialization errors when newer enum constants appear after version upgrades.

API DesignEnumSerialization
0 likes · 4 min read
Why Do Some Developers Hate Using Enums in API Design?
Java Captain
Java Captain
Jan 1, 2020 · Fundamentals

Why Enums Are Considered Poor Choices for API Return Values

The article explains why using enums as API return values is often criticized, highlighting their lack of extensibility, potential serialization errors when newer enum values appear, and contrasting this with the safety they provide as input parameters, illustrated with Java examples and community opinions.

API DesignEnumSerialization
0 likes · 4 min read
Why Enums Are Considered Poor Choices for API Return Values
Java Backend Technology
Java Backend Technology
Dec 18, 2019 · Backend Development

Mastering Null Handling in Java: Optional, Null Object Pattern & JSR 303/305

This article examines common pitfalls of null values in Java backend code, explains why returning null collections or objects can cause NullPointerExceptions, and presents robust solutions such as returning empty collections, using Optional, applying JSR‑303 validation, JSR‑305 annotations, and the Null Object pattern to improve API safety and readability.

API DesignJSR-303JSR-305
0 likes · 13 min read
Mastering Null Handling in Java: Optional, Null Object Pattern & JSR 303/305
Programmer DD
Programmer DD
Nov 30, 2019 · Frontend Development

Why Front‑Back Separation Matters: Practical API Guidelines for Modern Web Development

This article explains the need for front‑back separation, outlines the challenges of SPA architecture, provides a step‑by‑step implementation guide, and details a version‑1.0 API specification—including request/response formats, special data handling, and future front‑end trends—helping teams reduce integration effort and improve code maintainability.

API DesignFrontendSPA
0 likes · 12 min read
Why Front‑Back Separation Matters: Practical API Guidelines for Modern Web Development
Youzan Coder
Youzan Coder
Nov 13, 2019 · Mobile Development

Why Mobile Developers Need to Understand Backend Development and How to Get Started

Mobile developers should learn backend development to improve communication, resolve API inconsistencies, build data aggregation layers, and create their own infrastructure, and can start by mastering Spring Boot, SSM architecture, Dubbo, MySQL/MyBatis, and optional tools like Redis and security frameworks.

API DesignSSM frameworkSpring Boot
0 likes · 12 min read
Why Mobile Developers Need to Understand Backend Development and How to Get Started
Architects Research Society
Architects Research Society
Nov 5, 2019 · Backend Development

Principled GraphQL: Ten Principles for Building, Maintaining, and Operating Data Graphs

This article presents ten GraphQL principles—grouped into integrity, agility, and operations—that guide the design, evolution, and secure large‑scale deployment of a unified data‑graph layer, emphasizing a single schema, collaborative implementation, schema registries, performance monitoring, and structured logging.

API DesignData GraphGraphQL
0 likes · 17 min read
Principled GraphQL: Ten Principles for Building, Maintaining, and Operating Data Graphs
Alibaba Cloud Developer
Alibaba Cloud Developer
Oct 15, 2019 · Cloud Computing

7 Tough Challenges of Designing OpenAPI for Cloud Services and How to Overcome Them

This article examines why robust API specifications are crucial for cloud services, outlines seven major challenges—from choosing design patterns and resource modeling to error handling, versioning, and ecosystem integration—and offers practical guidance for building consistent, reliable OpenAPI interfaces at scale.

API DesignOpenAPIRESTful
0 likes · 20 min read
7 Tough Challenges of Designing OpenAPI for Cloud Services and How to Overcome Them
Architects' Tech Alliance
Architects' Tech Alliance
Oct 7, 2019 · Backend Development

Inter‑Process Communication Patterns and API Design for Microservices

This article explains how microservices, unlike monolithic applications, rely on inter‑process communication mechanisms, describes various interaction styles, API definition and evolution, handling partial failures, and compares synchronous (REST, Thrift) and asynchronous (messaging) IPC technologies.

API DesignIPCMicroservices
0 likes · 18 min read
Inter‑Process Communication Patterns and API Design for Microservices
MaGe Linux Operations
MaGe Linux Operations
Sep 17, 2019 · Fundamentals

Essential Checklist for Designing Clean Python Library APIs

This article distills the key recommendations from the 2017 PyCon talk “How to make a good library API”, offering a concise checklist that covers simplicity, consistency, flexibility, and security to help Python developers create intuitive, maintainable, and robust library interfaces.

API DesignPythonSoftware Engineering
0 likes · 11 min read
Essential Checklist for Designing Clean Python Library APIs
Programmer DD
Programmer DD
Jul 15, 2019 · Backend Development

Master Java Optional to Eradicate NullPointerExceptions and Write Cleaner Code

This article explains why NullPointerExceptions occur in Java, introduces the Optional class from Java 8 as a type‑safe alternative to null, and provides practical tips, code examples, and real‑world cases for using Optional to simplify error handling and improve API design.

API DesignCode RefactoringNullPointerException
0 likes · 7 min read
Master Java Optional to Eradicate NullPointerExceptions and Write Cleaner Code
Java Backend Technology
Java Backend Technology
May 14, 2019 · Backend Development

Why Traditional PageSize/PageIndex Pagination Breaks with Dynamic Data—and How to Fix It

This article examines the pitfalls of using static pageSize and pageIndex parameters for pagination on rapidly changing data sets, illustrates how data shifts can cause duplicate or missing records, and proposes client‑side de‑duplication, server‑side last‑ID pagination, and business‑level tolerance strategies.

API DesignDynamic Databackend
0 likes · 6 min read
Why Traditional PageSize/PageIndex Pagination Breaks with Dynamic Data—and How to Fix It
Alibaba Cloud Developer
Alibaba Cloud Developer
May 9, 2019 · Backend Development

What Makes a Good API? Principles and Best Practices for Robust Design

This article explores the challenges of API design, outlines fundamental principles such as clear mental models, simplicity, multiple implementations, and idempotency, and provides concrete best‑practice recommendations illustrated with the classic POSIX File API example.

API Designbackend developmentsoftware architecture
0 likes · 22 min read
What Makes a Good API? Principles and Best Practices for Robust Design
360 Tech Engineering
360 Tech Engineering
Apr 29, 2019 · Backend Development

Comprehensive Guide to GraphQL and Building a GraphQL API with ThinkJS

This article explains what GraphQL is, how it solves common REST API problems, details its request structure, schema, type system, fragments, aliases, interfaces, unions, and resolvers, and provides a step‑by‑step tutorial for creating a GraphQL server using ThinkJS, MongoDB, and Apollo Server, while also outlining its advantages and drawbacks.

API DesignApollo ServerGraphQL
0 likes · 21 min read
Comprehensive Guide to GraphQL and Building a GraphQL API with ThinkJS
MaGe Linux Operations
MaGe Linux Operations
Apr 21, 2019 · Fundamentals

Designing Clean Python Library APIs: A Practical Checklist

This article, based on a 2017 PyCon talk, provides a comprehensive checklist of best‑practice guidelines—covering simplicity, consistency, flexibility, and security—to help developers create intuitive, maintainable, and Pythonic library APIs.

API DesignLibrarySoftware Engineering
0 likes · 12 min read
Designing Clean Python Library APIs: A Practical Checklist
21CTO
21CTO
Dec 31, 2018 · Backend Development

Designing Robust APIs: Principles, Practices, and Real-World Examples

This article explores core API design principles—clear mental models, simplicity, multiple implementations—and offers concrete best‑practice guidance, from documentation and resource modeling to idempotency, compatibility, batch updates, and error handling, illustrated with the classic POSIX File API.

API DesignIdempotencycompatibility
0 likes · 21 min read
Designing Robust APIs: Principles, Practices, and Real-World Examples
Alibaba Cloud Native
Alibaba Cloud Native
Dec 28, 2018 · Backend Development

Essential API Design Principles and Practical Guidelines

This article explores why API design is crucial for large‑scale software systems, outlines fundamental design principles, presents detailed best‑practice recommendations, and discusses compatibility, idempotency, error handling, and versioning with concrete examples such as the POSIX File API.

API DesignDocumentationIdempotency
0 likes · 21 min read
Essential API Design Principles and Practical Guidelines
UC Tech Team
UC Tech Team
Dec 26, 2018 · Frontend Development

Reflections on the Design, Implementation, and Future of React Hooks

The article provides a comprehensive analysis of React Hooks, covering their injection model, persistent call ordering, debugging and testing strategies, API design considerations such as useReducer, Context Provider, useEffect, missing APIs, type handling, compilation optimizations, safety concerns, and the overall motivation behind moving from class components to hooks.

API DesignDebuggingFrontend
0 likes · 21 min read
Reflections on the Design, Implementation, and Future of React Hooks
Java Captain
Java Captain
Dec 20, 2018 · Fundamentals

Java API Design Checklist and Guidelines

This article provides a comprehensive checklist for designing Java APIs, covering package organization, naming conventions, type, method, exception, constructor, and documentation best practices, using clear directives such as “must”, “should”, “consider”, and “avoid” to help developers create clean, maintainable, and robust APIs.

API DesignChecklistbest-practices
0 likes · 17 min read
Java API Design Checklist and Guidelines
MaGe Linux Operations
MaGe Linux Operations
Nov 28, 2018 · Fundamentals

Essential Checklist for Designing Clean Python Library APIs

This article distills key recommendations from a 2017 PyCon talk into a practical checklist for building Python library APIs, covering simplicity, consistency, flexibility, and security to help developers create intuitive, reliable, and well‑structured interfaces.

API DesignLibraryPython
0 likes · 11 min read
Essential Checklist for Designing Clean Python Library APIs
Tencent Cloud Developer
Tencent Cloud Developer
Oct 19, 2018 · Backend Development

Design and Implementation of a Go Backend for a Lottery Mini Program

The article describes how to build a Go‑based backend for a WeChat lottery mini‑program using the Echo framework, Tencent Cloud load balancer, Nginx, Redis and MySQL, detailing the system architecture, API design, database and Redis integration, WeChat login flow, activity state machine, and lessons learned.

API DesignGoLottery System
0 likes · 12 min read
Design and Implementation of a Go Backend for a Lottery Mini Program
21CTO
21CTO
Oct 9, 2018 · Backend Development

How to Design a Usable, Flexible, Long‑Lasting API: Best Practices

This article explains how to design highly available, flexible, and durable APIs by identifying consumers, defining resources and operations, choosing the right API style, and following best practices such as proper HTTP methods, clear error messages, and hypermedia (HATEOAS) support.

API DesignHTTP methodsREST
0 likes · 10 min read
How to Design a Usable, Flexible, Long‑Lasting API: Best Practices
Java Captain
Java Captain
Sep 21, 2018 · Backend Development

Common Mistakes in API Design and the Benefits of a Unified ResultBean in Java

The article outlines frequent pitfalls in Java API design—such as inconsistent return formats, neglecting error cases, irrelevant or overly complex parameters, and missing essential response data—and advocates using a standardized ResultBean to improve readability, AOP integration, and automated testing.

API DesignResultBeancoding standards
0 likes · 4 min read
Common Mistakes in API Design and the Benefits of a Unified ResultBean in Java
MaoDou Frontend Team
MaoDou Frontend Team
Aug 21, 2018 · Backend Development

Why GraphQL Is Revolutionizing API Design: From Problems to Practice

GraphQL, created by Facebook in 2012 and open‑sourced in 2015, offers a flexible, efficient alternative to REST by allowing clients to request exactly the data they need, reducing redundancy, cutting request counts, and simplifying API evolution, with practical Node server and Apollo client implementations illustrated.

API DesignApolloGraphQL
0 likes · 5 min read
Why GraphQL Is Revolutionizing API Design: From Problems to Practice
Architecture Digest
Architecture Digest
Jul 19, 2018 · Operations

How to Prevent System Failures: Suspect Third‑Party Services, Guard Consumers, and Strengthen Your Own Service

The article presents practical strategies for avoiding service failures by treating third‑party dependencies as unreliable, designing robust APIs for consumers, and applying solid engineering principles such as degradation plans, timeout settings, traffic control, and resource‑limiting techniques.

API DesignFault Tolerancereliability
0 likes · 16 min read
How to Prevent System Failures: Suspect Third‑Party Services, Guard Consumers, and Strengthen Your Own Service
Full-Stack Internet Architecture
Full-Stack Internet Architecture
May 29, 2018 · Backend Development

Microservices Architecture: Principles, Benefits, Drawbacks, and Governance

This article explains microservices architecture, contrasting it with monolithic systems, outlines its core characteristics, communication patterns, advantages, disadvantages, design considerations, API importance, governance practices, fault‑tolerance strategies, container integration, and real‑world examples such as Netflix and Twitter.

API DesignMicroservicesService Governance
0 likes · 17 min read
Microservices Architecture: Principles, Benefits, Drawbacks, and Governance
MaGe Linux Operations
MaGe Linux Operations
May 1, 2018 · Fundamentals

Designing Clean Python Library APIs: A Practical Checklist

This article, based on a 2017 PyCon talk, presents a comprehensive checklist for building Python library APIs, covering simplicity, consistency, flexibility, and security with concrete examples and actionable guidelines to help developers create intuitive and reliable interfaces.

API DesignLibraryconsistency
0 likes · 11 min read
Designing Clean Python Library APIs: A Practical Checklist
ITFLY8 Architecture Home
ITFLY8 Architecture Home
Apr 2, 2018 · Backend Development

Mastering Web API Design: A 7‑Step Methodology for Robust Services

This article outlines a practical seven‑step methodology for designing, documenting, and publishing Web APIs—covering everything from listing semantic descriptors and drawing state diagrams to harmonizing names, choosing media types, creating semantic profiles, writing code, and finally releasing a stable, consumable service.

API DesignRESTWeb API
0 likes · 15 min read
Mastering Web API Design: A 7‑Step Methodology for Robust Services
ITFLY8 Architecture Home
ITFLY8 Architecture Home
Mar 19, 2018 · Backend Development

Mastering API Design: Essential Standards for Mobile Apps

This article presents a comprehensive guide to API design for mobile applications, covering documentation standards, common request and response parameters, naming conventions, thin‑client principles, extensibility, security, compatibility, performance and user‑experience optimizations, with practical examples and code snippets.

API DesignMobile BackendREST
0 likes · 24 min read
Mastering API Design: Essential Standards for Mobile Apps
ITFLY8 Architecture Home
ITFLY8 Architecture Home
Jan 27, 2018 · Backend Development

Mastering RESTful Architecture: From Basics to Advanced HATEOAS

This article explains the origins, core concepts, design principles, common misconceptions, and maturity levels of RESTful APIs, illustrating how resources, representations, HTTP verbs, and hypermedia (HATEOAS) together enable scalable, decoupled web services for modern client platforms.

API DesignHTTPREST
0 likes · 13 min read
Mastering RESTful Architecture: From Basics to Advanced HATEOAS
Suning Technology
Suning Technology
Nov 17, 2017 · Operations

How Suning Scaled Its API Platform: Standards, High Availability, and O2O Event Readiness

This article explains how Suning built a standardized, high‑availability API gateway, detailing naming conventions, documentation practices, protocol choices, error‑code design, dynamic configuration, SDK automation, system refactoring, monitoring, intelligent alerting, and the specific preparations made for the O2O shopping festival.

API DesignCloud ComputingHigh Availability
0 likes · 16 min read
How Suning Scaled Its API Platform: Standards, High Availability, and O2O Event Readiness
21CTO
21CTO
Oct 18, 2017 · Backend Development

Why GraphQL Might Replace REST: Benefits, Costs, and Real‑World Examples

This article explains why GraphQL addresses key limitations of REST APIs—reducing round‑trips, improving client‑server decoupling, and enhancing developer experience—while also discussing its flexibility costs, security concerns, caching strategies, and practical code examples comparing both approaches using a Star Wars data scenario.

API DesignGraphQLREST
0 likes · 18 min read
Why GraphQL Might Replace REST: Benefits, Costs, and Real‑World Examples
21CTO
21CTO
Oct 10, 2017 · Backend Development

Designing a Unified RESTful API: Principles, URL Naming, and Versioning

This article presents a comprehensive, academically‑styled guide for designing a unified RESTful API, covering core concepts such as REST constraints, HATEOAS, security, idempotency, URL naming conventions, request/response structures, version control, and recommended implementation tools.

API DesignHTTPRESTful API
0 likes · 14 min read
Designing a Unified RESTful API: Principles, URL Naming, and Versioning
Node Underground
Node Underground
Sep 21, 2017 · Backend Development

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

This article presents ten concise best‑practice guidelines for designing clean, efficient REST APIs, covering proper use of HTTP methods, status codes, headers, framework selection, black‑box testing, and five additional crucial recommendations to help developers create elegant and maintainable web services.

API DesignHTTP methodsREST API
0 likes · 1 min read
10 Essential REST API Design Best Practices Every Backend Developer Should Follow
Hujiang Technology
Hujiang Technology
Jun 20, 2017 · Backend Development

Design and Management of a Unified Error Code System for Distributed Backend Services

This article explains the concept, benefits, and implementation details of a unified error‑code management platform, covering code allocation, handling strategies in microservice architectures, API security considerations, and performance optimizations to reduce development friction and improve system reliability.

API DesignMicroserviceserror codes
0 likes · 12 min read
Design and Management of a Unified Error Code System for Distributed Backend Services
Architecture Digest
Architecture Digest
Mar 9, 2017 · Backend Development

Common Design Issues and Best Practices for Distributed System Interfaces

The article outlines key challenges in distributed API design—including date formatting, decimal precision, response structures, idempotency, security, and naming consistency—and provides practical recommendations to improve usability, scalability, and maintainability across backend services.

API DesignIdempotencybackend
0 likes · 12 min read
Common Design Issues and Best Practices for Distributed System Interfaces
Taobao Frontend Technology
Taobao Frontend Technology
Feb 16, 2017 · Frontend Development

Mastering API Design: Essential Principles for Clean, Usable Frontend APIs

This comprehensive guide explores the fundamentals of API design for front‑end development, covering naming conventions, lexical correctness, parameter ordering, return values, versioning, and extensibility, and provides practical code examples to help developers create intuitive, maintainable, and future‑proof interfaces.

API DesignJavaScriptbest practices
0 likes · 29 min read
Mastering API Design: Essential Principles for Clean, Usable Frontend APIs
Architecture Digest
Architecture Digest
Jan 5, 2017 · Backend Development

The Past, Present, and Future of APIs: From Mechanical Turk to Autonomous APIs

This article traces the evolution of APIs from early mechanical automata and historic milestones like Deep Blue to today’s REST‑based Web APIs, highlights current challenges such as documentation drift and versioning, and proposes autonomous, self‑describing APIs powered by vocabularies and discovery services.

API DesignAPI discoveryAutonomous APIs
0 likes · 11 min read
The Past, Present, and Future of APIs: From Mechanical Turk to Autonomous APIs
Architecture Digest
Architecture Digest
Jan 2, 2017 · Backend Development

API Design Guidelines for Mobile Applications

This article presents comprehensive API design standards for mobile apps, covering request/response conventions, naming rules, data type handling, security measures, compatibility, performance and user‑experience optimizations, and offers practical examples to help front‑end and back‑end engineers create robust, maintainable interfaces.

API DesignRESTbackend
0 likes · 19 min read
API Design Guidelines for Mobile Applications
21CTO
21CTO
Dec 18, 2016 · Backend Development

How to Design Clean, Stable, and User‑Friendly APIs: Best Practices

Effective API design requires shifting from a developer‑centric mindset to the user’s perspective, emphasizing clear documentation, stability, versioning, flexibility, security, and ease of use, while avoiding unnecessary complexity and ensuring consistent, well‑structured interfaces for diverse clients across web, mobile, and IoT platforms.

API DesignDocumentationVersioning
0 likes · 12 min read
How to Design Clean, Stable, and User‑Friendly APIs: Best Practices
Qunar Tech Salon
Qunar Tech Salon
Oct 19, 2016 · Backend Development

Designing Experience APIs and Backends for Frontends: Facades, Microservices, and Custom Payload Strategies

The article explores the rise of experience APIs and Backends for Frontends, discussing how microservice architectures, API facades, custom payloads, media types, Prefer headers, and GraphQL can be used to tailor APIs for diverse client platforms while weighing the trade‑offs for small versus large teams.

API DesignAPI contractsBFF
0 likes · 17 min read
Designing Experience APIs and Backends for Frontends: Facades, Microservices, and Custom Payload Strategies
Java High-Performance Architecture
Java High-Performance Architecture
Oct 14, 2016 · Backend Development

Why GitHub Switched to GraphQL: Benefits Over REST APIs

GitHub introduced a GraphQL‑based public API to overcome REST’s scalability and flexibility limits, allowing clients to specify exact data needs, reduce network overhead, and combine multiple queries into a single request, while offering features like batching, subscriptions, and data latency control.

API DesignGitHubGraphQL
0 likes · 6 min read
Why GitHub Switched to GraphQL: Benefits Over REST APIs
ITFLY8 Architecture Home
ITFLY8 Architecture Home
Jun 11, 2016 · Backend Development

Mastering RESTful Architecture: From Resources to OAuth Authentication

This article explains the fundamentals of RESTful architecture—including resources, uniform interfaces, URIs, statelessness—and compares it with ROA, SOA, and RPC, while also covering authentication methods such as Basic, Token, and OAuth, offering practical guidance for building robust microservice APIs.

API DesignMicroservicesOAuth
0 likes · 15 min read
Mastering RESTful Architecture: From Resources to OAuth Authentication