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.
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.
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.
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.
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.
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.
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.
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.
The article examines the reasons behind mandating POST for every API endpoint, compares GET and POST characteristics, discusses RESTful principles, highlights practical pros and cons, and offers guidance on choosing the most suitable HTTP method based on business and technical considerations.
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.
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.
This article explains why consistent API return‑code design matters, shows how to model error codes after HTTP status segmentation, adds structured messages for both developers and end‑users, and demonstrates how unified codes enable effective monitoring and alerting.
This article walks through the requirements, backend API design, and front‑end implementation—including TypeScript code snippets—for a QR‑code login system where the code expires after two minutes, users confirm login on mobile, and the web client polls for status updates.
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.
This article explains why a unified API response format like ResultBean is essential for Java Spring controllers, outlines common interface design mistakes, presents controller conventions, and demonstrates an AOP solution with logging and exception handling to improve code readability and maintainability.
The article explains common pitfalls in Java backend interface design, proposes a unified ResultBean response format, outlines controller coding standards, and demonstrates how to use Spring AOP for logging and exception handling, providing complete code examples and configuration snippets.
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.
The article examines why certain companies mandate POST for every API, compares GET and POST in terms of security, payload size, caching, and semantics, and discusses the trade‑offs and real‑world implications of such a blanket rule for backend development.
This article explores common frustrations with TypeScript, demonstrates how to design a robust `pick` API using generics, keyof, and advanced type tricks, and offers practical guidelines for creating type‑safe, developer‑friendly code.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
The article examines why developers spend excessive time on low‑value, invisible tasks such as answering integration tests and production issues, and proposes the RQN error‑message format plus supporting query interfaces to automate responses, reduce manual effort, and improve operational efficiency.
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.
A seemingly simple API change revealed deep flaws in parameter handling, prompting a review of technical, business, and flow‑control parameters and outlining essential API design principles to keep internal logic hidden and maintain clean, maintainable services.
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.
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.
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.
This article explains practical ways to achieve extensibility at multiple layers—code, API, framework, and system platform—by using design patterns, JSON‑based APIs, SPI mechanisms, and extension‑point architectures to minimize impact on existing functionality.
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.
This article explains what API idempotency is, why it is needed, which interfaces should be idempotent, and presents various implementation methods such as frontend interception, database unique indexes, optimistic and pessimistic locks, JVM locks, distributed locks, and token‑based approaches.
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.
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.
The article examines the challenges of interface placement, service dependencies, and client-specific adaptations in a complex supply‑chain system and proposes an API aggregation layer and Backend‑for‑Frontend (BFF) pattern, detailing implementation with Spring Cloud and practical team division.
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.
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.
This article shares practical insights on API design, covering fundamental concepts, rate‑limiting strategies, versioning practices, security considerations, and tips for cross‑team API integration, all illustrated with real‑world examples and concise code snippets.
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.
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.
This article outlines six key software architecture principles—reuse before build, cloud‑ready design, scalability, complexity reduction, API‑first approach, and frequent small releases—to help organizations make strategic technical decisions and avoid common pitfalls.
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.
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.
This article examines the reasons behind mandating POST for all API endpoints, compares GET and POST characteristics, discusses the practical implications of such a policy, and offers guidance on when each HTTP method is appropriate for backend development.
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.
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.
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.
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.
The article explains why a unified response format (ResultBean) is essential for Java Spring APIs, lists common interface design mistakes, provides concrete coding guidelines for controllers, and demonstrates how to use AOP for logging and exception handling with clear code examples.
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.
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.
This article compares four major API architectural styles—RPC, SOAP, REST, and GraphQL—detailing their mechanisms, advantages, disadvantages, and suitable use cases to help developers choose the most appropriate approach for their projects in today’s fast‑changing environment.
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.
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.
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.
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.
The article explains the technical reasons behind mandating POST for all API endpoints, comparing GET and POST in terms of security, payload size, data types, caching, and typical use cases, and argues that a balanced approach is usually more appropriate.
This article explains Google’s API design guidelines for resource naming, covering uniqueness, URI path formatting, collection identifiers, ID constraints, full and relative names, and how to annotate fields in protobuf messages for clear, consistent backend APIs.
This guide explains the core principles of resource‑oriented API design, including naming resources, using standard and custom methods, modeling hierarchical collections, and adhering to stateless protocols, while drawing on REST concepts and Google’s API design guidelines.
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.
This article analyzes the four major API architectural styles—RPC, SOAP, REST, and GraphQL—detailing their mechanisms, strengths, weaknesses, and typical use cases, and provides guidance on selecting the most suitable style based on language, environment, and resource constraints.
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.
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.
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.
This article presents 22 practical best‑practice guidelines for designing consistent, secure, and user‑friendly RESTful APIs, covering URL naming conventions, HTTP methods, versioning, pagination, JSON naming, monitoring endpoints, CORS, error handling, and other essential considerations for backend developers.
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.
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.
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.
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.
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.
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.
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.
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.
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.
This article explains how front‑end engineers can shift their mindset, adopt a BFF layer and GraphQL, and automate the integration with a data warehouse to become data owners, improve efficiency, and reduce reliance on back‑end resources in large‑scale data platforms.
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.
The article explains the origins of REST, breaks down its core concepts of resources, representations, and state transfer, details HTTP methods, URL versioning, status codes, and provides practical RESTful API design examples while contrasting REST with traditional Web Services.
This article explains why front‑end and back‑end separation is essential, describes the SPA‑based architecture, outlines practical steps for responsibility division, development workflow, and implementation, and provides a detailed V1.0.0 API specification with request and response formats.
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.
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.
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.
The article examines why certain companies mandate POST for every API, comparing GET and POST characteristics, discussing RESTful principles, ROI considerations, and the practical trade‑offs of such a uniform approach, while offering guidance on when each method is appropriate.
This guide explains why APIs are essential, how to model data and resources, design RESTful endpoints, handle versioning, and implement pagination, providing practical best‑practice rules that make APIs robust, clear, and developer‑friendly.
Most companies favor POST requests because they are more secure, can handle larger and more complex payloads, avoid URL length limits, and are suited for modifying data, while GET is better for retrieving static resources or simple queries, reflecting industry best practices for API design.
The article examines why certain companies mandate POST for every API, comparing GET and POST across security, payload size, data types, performance, and proper usage, and offers practical guidelines for designing sensible HTTP method conventions.
This article compares the four major API architectural styles—RPC, SOAP, REST, and GraphQL—detailing their mechanisms, advantages, drawbacks, and typical use cases, and guides developers on selecting the most suitable approach based on project requirements, performance, and ecosystem considerations.
This article explains why APIs are essential, how to model data and resources, apply RESTful principles, choose clear naming conventions, manage versioning, and implement pagination, providing practical guidelines and code examples for building maintainable and developer‑friendly backend services.
This article explains essential API design best practices, covering data modeling, resource naming, RESTful conventions, HTTP methods, version control strategies, and pagination techniques, with practical examples to help developers create robust, maintainable, and developer-friendly APIs.
This article outlines a practical approach to designing open platform APIs, covering usability, security, stability, service provider application setup, OAuth2 authorization flow, system and business request parameters, and concrete signing and verification code examples.
This article explains the evolution from MVC to SPA, highlights the pain points of tightly coupled front‑end and back‑end development, and provides concrete responsibility separation, development processes, and a detailed API specification to enable efficient, loosely‑coupled collaboration in modern web projects.
This article outlines a practical approach to designing open‑platform APIs, covering service‑provider application registration, usability, security, OAuth2‑based authorization, systematic and business request parameters, signature generation, verification, and best‑practice code examples.
This article explains why well‑designed APIs are essential, covers data modeling, resource hierarchy, RESTful conventions, CRUD operations, versioning strategies, and pagination techniques, providing concrete examples and code snippets to help developers build robust, maintainable backend services.
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.
