The article examines the long‑standing array‑order pitfall of Promise.all, explains how the TC39 Stage‑3 Await Dictionary proposal introduces Promise.allKeyed to return objects keyed by name, and shows why this change improves readability, reduces hidden bugs, and fits TypeScript better.
Filippo Valsorda proposes a PHC‑style one‑line Passkey record format that reuses WebAuthn authenticator data, eliminates the need for cross‑account Credential ID uniqueness checks, and includes a draft stateless crypto/passkey Go 1.28 API detailing registration and login flows.
The article explains how Go's map type, being a reference, lacked a safe way to test aliasing, leading to a lengthy design discussion that introduced the zero‑cost maps.Same function, settled naming, nil/NaN semantics, generic signatures, and ultimately earned acceptance after months of debate.
The article shows how overusing ResponseEntity in Spring Boot controllers makes code noisy and mixes business logic with HTTP handling, and introduces four declarative alternatives—@ResponseStatus on methods or exceptions, direct object returns, global ProblemDetail via @ControllerAdvice, and a ResponseBodyAdvice wrapper—to produce cleaner, more testable APIs.
The article explains why front‑end/back‑end separation is needed, outlines the challenges of the MVC era, describes the SPA‑based separation model, and provides a detailed, versioned interface specification—including request/response formats, mock server workflow, and special field rules—to streamline collaborative development.
The article shows how duplicating 20‑40 lines of request‑building code for each low‑code table operation leads to maintenance risk, and demonstrates extracting two generic Java methods that encapsulate invariant logic while parameterising fields, tables, and apps, dramatically reducing code and clarifying responsibilities.
The article explains the causes of duplicate requests in distributed systems, defines idempotency, and presents eight concrete implementation strategies—including token mechanisms, unique database indexes, optimistic and pessimistic locks, distributed locks, state machines, request serial numbers, and MQ‑based handling—each with code samples, advantages, drawbacks, and usage guidelines.
The article explains why simple key‑based idempotency fails when a second request carries different parameters, and demonstrates how to use database row locks, request fingerprinting, state machines, and explicit error handling to guarantee safe, non‑duplicate execution in payment‑critical APIs.
The article explains how integrating Spring HATEOAS transforms a Level‑2 REST API into a hypermedia‑driven Level‑3 API, automatically exposing actionable links, reducing front‑end state‑handling, enabling type‑safe URL generation, and simplifying RBAC integration, thereby eliminating the need for constant Swagger revisions.
The article explains how MCP adds an AI‑friendly protocol layer on top of traditional Java backend services, enabling models to call tools safely, and outlines the security, governance, and testing practices Java engineers need to adopt.
This article walks through the complete interview‑style design of a billion‑scale URL shortener, covering requirements, capacity estimation, API definitions, database schema, short‑code generation algorithms, sharding, caching, load balancing, rate limiting, and expiration handling, while illustrating each step with concrete examples and calculations.
Java developers using AI to generate code find speed gains, but vague API boundaries cause AI to misinterpret intent; clear, well‑named, constrained interfaces are essential for reliable AI assistance, making API design a core factor in future development productivity.
The Go team introduced a new uuid package to the standard library, offering lightweight functions for generating, parsing, serializing, and comparing UUID version 4 and version 7 values, integrating with database/sql, using a [16]byte type compatible with google/uuid, and providing detailed design rationale, implementation details, and a comparison with the existing third‑party library.
This article presents a comprehensive, production‑grade guide for Spring Boot enterprise projects, detailing why and how to adopt four unified standards—response structure, exception handling, logging, and parameter validation—to ensure stable contracts, clear error semantics, observable systems, and robust input boundaries even under high concurrency.
This article shows how FastAPI combined with Pydantic lets you define schema‑driven validation—including nested models, Field metadata, and separate input/output models—so you can drop manual if‑else checks and rely on automatic 422 responses and generated OpenAPI docs.
The article examines why a company might require every HTTP API to use POST, compares GET and POST characteristics, discusses RESTful principles, outlines the trade‑offs of a POST‑only policy, and offers practical guidance for choosing the right method based on business needs.
Go has refused default parameters for 15 years, a choice rooted in its philosophy of explicitness over implicit behavior; the article examines this deliberate ‘poverty’, explores the pitfalls of default arguments, and presents alternative patterns like wrapper functions, config structs, functional options, and pointer checks with real code examples.
Most teams treat REST APIs as merely functional, leading to chaotic naming, frequent breaking changes, rising front‑end costs, and JVM pressure; this article re‑examines REST’s constraint‑based architecture and presents concrete Java‑centric design principles, best‑practice guidelines, and implementation examples to build sustainable, evolvable APIs.
The article examines the reasons behind a company's rule to use POST for every API, compares GET and POST characteristics, shares community opinions, discusses the trade‑offs of strict RESTful enforcement, and suggests when such a convention is appropriate.
The article examines why a company might mandate POST for every API, compares GET and POST characteristics, discusses RESTful principles, outlines the technical and business trade‑offs of such a policy, and shares practical guidance for choosing the right HTTP method.
An experienced developer reflects on a Zhihu question about mandating POST for all interfaces, compares GET and POST characteristics, shares personal practices, presents community opinions on RESTful benefits and drawbacks, and describes his company's concrete API rule using a single POST/action endpoint with protobuf and gRPC integration.
This guide presents 22 practical best‑practice rules for designing consistent, resource‑oriented RESTful APIs, covering naming conventions, URL structure, parameter casing, versioning, monitoring endpoints, security measures, pagination, field selection, CORS, error handling, and more, with concrete code examples.
The article examines why a company might mandate POST for every API, compares GET and POST characteristics, discusses RESTful best‑practice expectations, highlights the hidden costs of over‑standardization, and presents a more nuanced approach to API design for dynamic and static services.
This article walks through the complete development of a minimal Model Context Protocol (MCP) server using Spring Boot 3 and Server‑Sent Events, illustrating how OpenSpec drives the workflow from proposal and task breakdown to design, implementation, testing, and integration with Claude Code.
The article examines the reasons behind a company's rule that all HTTP interfaces must use POST, compares POST and GET characteristics, discusses RESTful benefits and drawbacks, and offers practical guidance on choosing the right method for different API scenarios.
This article explains how to design a consistent JSON response format for Spring Boot APIs, covering status‑code conventions, message handling, a reusable Result wrapper class, controller simplification, and a global @ResponseResult annotation with interceptor and advice for automatic response packaging.
Returning HTTP 200 for every API response hides real error information, complicates client error handling, breaks monitoring, caching and retry logic, and defeats the purpose of HTTP semantics, while proper status‑code usage simplifies development and improves reliability.
Four years after Go introduced generics, the language’s core team has proposed adding generic methods, a change that resolves the long‑standing asymmetry between generic functions and types, improves API fluency, and reshapes code organization while preserving backward compatibility, though interface support remains limited.
The article argues that the recent hype around Skills and the criticism of MCP stem from a mindset problem: developers treat MCP like a REST API wrapper, leading to poor server designs, and it offers six concrete design principles to build agent‑friendly MCP services.
This article compares REST and GraphQL APIs for Spring Boot, explains their definitions, core differences, implementation steps with code samples, and provides clear criteria for selecting the right approach based on use‑case, performance, caching, and security considerations.
This article outlines ten frequent JSON pitfalls—from deeply nested structures and string literals to missing timezone data and lack of versioning—provides clear before‑and‑after code examples, and offers practical guidelines to write cleaner, safer, and more maintainable JSON for APIs and configuration files.
The article examines seven new Pydantic v2 capabilities—TypeAdapter, Annotated + Field, deterministic validators, precise serialization hooks, computed_field, RootModel, and ConfigDict—showing how each resolves common API‑validation pain points, improves contract clarity, and boosts performance with concrete code examples and a FastAPI integration.
This article examines why APIs are more than data pipes, outlines three essential design questions, and provides concrete strategies—including single‑purpose endpoints, clear naming, batch calls, async core logic, caching, compression, HTTPS, token authentication, rate limiting, versioning, and maintenance practices—to create stable, efficient, and secure APIs.
This article examines common pitfalls of asynchronous Go logging—such as channel blocking, GC pressure, and poor API design—and presents concrete solutions using non‑blocking writes, sync.Pool object reuse, and context‑aware variadic APIs, all demonstrated with real code from the easyms.golang project.
This guide teaches you how to design clean, consistent RESTful APIs by following proven best practices for resource modeling, URL design, filtering, sorting, pagination, proper HTTP methods, status codes, error handling, and versioning to avoid common pitfalls and improve maintainability.
This guide outlines comprehensive API interface design best practices, covering design principles, naming conventions, parameter structures, return code standards, security measures, and a reusable documentation template to ensure flexible, efficient, and secure service development.
This article explains how to design secure and reliable APIs for third‑party integration by covering API key generation, AK/SK authentication, callback URLs, permission models, token mechanisms, signature creation, replay‑attack prevention, HTTPS encryption, rate limiting, logging, data masking, idempotency, versioning, standardized response formats and documentation tools.
This comprehensive guide explains the core concepts, constraints, implementation examples, request‑response flows, and pros‑and‑cons of five major API architectural styles—REST, GraphQL, gRPC, WebSocket, and Webhook—helping developers choose the right approach for different scenarios.
This article explains how to structure API responses in a microservice environment by using a standard JSON format, custom status code ranges, a Result wrapper class, and Spring annotations with interceptors to automatically package and handle responses and errors in a clean, maintainable way.
This article examines the architectural challenges and opportunities of digital transformation, outlines layered, API‑first, and data‑driven design principles, and provides practical technology‑selection and implementation roadmaps to help enterprises create resilient, scalable, and business‑centric IT systems.
This article explains common pitfalls in Java controller interface design—such as inconsistent return formats, missing failure handling, and inappropriate parameters—and demonstrates how a unified ResultBean response combined with AOP logging and exception handling can improve code readability, maintainability, and testability.
This article walks through the complete design of a high‑performance, highly available URL shortener—covering business value, requirement analysis, capacity estimation, API definitions, database schema, key generation algorithms, sharding, caching, load balancing, and expiration cleanup—so you can impress interviewers with a thorough, scalable solution.
The article analyzes the long‑standing issues of Go's original encoding/json package, explains the design and API of the experimental encoding/json/v2 and jsontext packages, and shows how the new implementation improves correctness, flexibility, and performance while preserving compatibility.
This article explains how to design a standardized JSON response format for Java back‑end APIs, introduces a Result wrapper class, and shows how to automate response wrapping using a custom @ResponseResult annotation, interceptors, and Spring's ResponseBodyAdvice for cleaner, more maintainable code.
The article explains how inconsistent API return types, missing error handling, irrelevant or complex parameters, and lack of proper result objects lead to maintenance headaches, and demonstrates a disciplined approach using a generic ResultBean, standardized controller conventions, and Spring AOP for logging and exception handling.
The article examines why some companies mandate POST for every API, compares GET and POST characteristics, discusses RESTful principles, weighs the benefits and drawbacks, and offers practical guidance while showcasing an open‑source microservice project for deeper learning.
This article distills key guidelines from Effective Java, covering static factory methods, builder patterns, singleton protection, utility class design, memory‑leak avoidance, equals/hashCode contracts, composition over inheritance, generics, enums, exception handling, and many other best‑practice rules to help Java developers write cleaner, safer, and more maintainable code.
This article explains how to design robust API controller interfaces by covering signature verification, RSA encryption, IP whitelisting, rate limiting, parameter validation, unified response formats, exception handling, request logging, idempotency, record limits, stress testing, asynchronous processing, data masking, and comprehensive documentation.
This guide provides a comprehensive walkthrough of the new streamable HTTP transport mode introduced in MCP SDK v1.9.0, covering server and client configuration, core parameters, session‑id handling, sample implementations, multi‑instance deployment, and practical testing results.
This tutorial explains how to build scalable, maintainable FastAPI APIs by modularizing routers, implementing path‑based version control, centralizing dependency injection, applying role‑based access control, using custom middleware, and nesting routers for complex applications.
This article explains the differences between Body and Params parameters in Spring Boot, covering various Content‑Type configurations such as query, x‑www‑form‑urlencoded, form‑data, binary, and JSON, and provides code examples and a clear comparison table to help developers choose the right approach for stable and efficient API design.
The article traces how an early AJAX API that used only HTTP 200 and a simple JSON wrapper devolved into a tangled mix of proper RESTful codes, custom three‑digit‑plus statuses, pseudo‑resources, PATCH work‑arounds, and finally a pragmatic scheme that keeps 200 for success, adds extended numeric categories, and adopts verb‑adjective‑resource method names for clarity.
This article explains how treating JSON responses as UI components—by converting data models into view‑models on the server and exposing screen‑specific endpoints through a Backend‑for‑Frontend layer—solves the mismatch between REST resources and ever‑changing front‑end requirements.
The article narrates a top architect’s experience with early API error handling, the chaos caused by non‑standard HTTP status codes, the shift toward RESTful conventions, and later promotional offers for AI tools, illustrating both technical lessons and marketing pitches.
This article analyzes the coupling problems caused by multiple controller calls and third‑party push interfaces, proposes a TPS microservice to centralize third‑party interactions, demonstrates Java Feign interfaces and enum‑based routing, and shows how backend and frontend can achieve low‑coupling architecture while reducing code duplication.
Learn how to leverage Pydantic in FastAPI to handle optional fields, validate nested data structures, enforce complex business rules with model validators, forbid extra fields, work with polymorphic models, and validate query and path parameters, all illustrated with clear Python code examples.
This article explains how view‑driven (or BFF) API design replaces bulky data‑centric interfaces with UI‑aligned response models, reducing data redundancy, eliminating logic leakage, and streamlining front‑back collaboration for faster, more reliable product delivery.
The article outlines eighteen critical considerations for designing backend interfaces, ranging from documentation format and unified parameter schemas to encryption, idempotency, versioning, and monitoring, providing interview-ready insights that can impress hiring managers.
This article examines four major API architectural styles—RPC, SOAP, REST, and GraphQL—detailing their mechanisms, advantages, disadvantages, and typical use cases, and provides guidance on selecting the most suitable style based on project requirements and constraints.
This article provides a thorough guide on API (interface) fundamentals, design principles, optimization techniques, security measures, and maintenance practices, offering practical examples and code snippets for building robust, high‑performance modern backend services.
This guide presents comprehensive best‑practice recommendations for building APIs—defining clear contracts, applying six design principles, optimizing performance through batching, async and caching, enforcing robust security with encryption, signing and rate‑limiting, and ensuring long‑term maintainability via versioning, documentation and structured logging.
This article explains the importance of well‑designed API and database structures, outlines principles for creating clear and traceable error codes, provides response format examples, discusses error propagation strategies, highlights common pitfalls, and proposes a full‑link trace‑id logging system for backend services.
The article outlines a comprehensive approach to third‑party API design, covering core principles such as security, reliability, usability and extensibility, detailed key‑management and authentication mechanisms, RESTful API specifications, implementation steps with code samples, and best‑practice recommendations for robust and maintainable integrations.
This guide walks through building robust API controller interfaces by covering request signing, RSA encryption, IP whitelisting, rate limiting, parameter validation, unified response formats, exception handling, logging, idempotent design, request size limits, stress testing, asynchronous processing, data masking, and comprehensive documentation.
This article outlines best‑practice techniques for building robust API controller interfaces, covering request signing, RSA encryption, IP whitelisting, rate limiting, parameter validation, unified responses, exception handling, logging, idempotency, record limits, stress testing, asynchronous processing, data masking, and comprehensive documentation.
This article explores why simplicity is essential in software development, examines the distinction between essential and accidental complexity, presents real‑world case studies of product and code complexity, and offers practical guidelines such as KISS, single‑responsibility, API minimization, and automation to achieve more maintainable and understandable systems.
This article explores how software engineers can reduce both essential and accidental complexity by applying principles such as KISS, single responsibility, clear API design, and thoughtful refactoring, illustrated with real‑world Java code examples and product‑design case studies.
The article proposes a Streaming Backend‑for‑Frontend (BFF) layer to unify heterogeneous AI agents, handle Server‑Sent Events streams, and resolve interface inconsistencies, offering a practical architecture for generative‑AI‑native systems across IDEs, DevOps, and team‑AI scenarios.
The article presents a comprehensive checklist of critical questions covering API design, system architecture, performance tuning, data consistency, reliability, automation, and advanced features that guide backend developers toward building scalable, secure, and high‑performance services.
While GraphQL promises precise data fetching and reduced bandwidth, this article examines its hidden drawbacks—complex queries, performance hits, rate‑limit challenges, and evolving schema complexity—showing why REST remains the more reliable, widely supported API standard for most applications.
This article explains how to create a consistent JSON API response format—including custom status codes, message fields, and a Result wrapper—by using a @ResponseResult annotation, an interceptor, and ResponseBodyAdvice in Spring Boot, while also offering tips for optimization and error handling.
This article provides an in‑depth comparison of GraphQL and REST API paradigms, outlining their principles, typical request examples, key differences in data fetching, flexibility, documentation, caching, error handling, performance, tooling, and guidance on choosing the appropriate approach for various project scenarios.
Idempotency ensures that repeated API calls produce the same result without side effects, and this guide explains its principles, common scenarios like payments and messaging, root causes of idempotency failures, and multiple implementation strategies—including unique constraints, optimistic and pessimistic locks, distributed locks, token mechanisms, state machines, and deduplication tables—with practical code examples.
This article explains the API‑First design methodology, outlining its core principles, implementation steps, best practices, and a real‑world e‑commerce case study to help architects build flexible, maintainable, and scalable systems.
This article presents a comprehensive checklist of 18 practical API design rules—including signature, encryption, IP whitelisting, rate limiting, validation, unified responses, exception handling, logging, idempotency, pagination, stress testing, async processing, data masking, documentation, request methods, headers, batch operations, and single‑responsibility principles—to help developers build secure, maintainable, and high‑performance services.
Facing a critical production deadline, the author shares a three‑step communication and process framework—empathic praise, collaborative brainstorming for an interface delivery review, and reflective design improvement—to strengthen middle‑platform team cohesion and establish robust API governance practices.
This article explains how to standardize API responses in Spring Boot by defining a JSON result format, using custom annotations, interceptors, and ResponseBodyAdvice to automatically wrap controller return values, while also discussing status code design, message handling, and code simplification techniques.
This article outlines the design and implementation of a unified WebSocket communication service, covering background motivations, project goals, core architecture, message reliability mechanisms using RabbitMQ, message classification, API specifications, and unified message formats to enable efficient, decoupled real‑time messaging across backend applications.
This article explains how to choose between fine‑grained and coarse‑grained resource designs in REST APIs, illustrating trade‑offs with blog‑post examples, showing how to model business processes as intent resources, and discussing the impact of avoiding PUT in favor of CQRS.
This article explains the origins of REST, why modern developers must follow RESTful conventions, and provides a step‑by‑step guide—including domain naming, versioning, endpoint design, HTTP verbs, filtering, status codes, error handling, hypermedia links, and data formats—illustrated with concrete code snippets.
This article outlines the design of an internal WebSocket communication service that abstracts real‑time messaging, reduces code coupling, supports various business scenarios, ensures reliable delivery with RabbitMQ, defines unified APIs and message formats, and demonstrates a DDD‑based project structure for easy integration.
This article outlines comprehensive backend API design guidelines, covering parameter validation, extensibility, idempotency, logging, thread‑pool isolation, third‑party error handling, asynchronous processing, parallel queries, rate limiting, security, lock granularity, and strategies to avoid long‑running transactions.
A RESTful API is an HTTP‑based design that treats each resource as a URI, uses standard verbs (GET, POST, PUT, PATCH, DELETE) for CRUD operations, returns appropriate status codes, supports content negotiation, versioned secure endpoints, clear noun‑based naming, pagination, filtering, HATEOAS links, and avoids embedding actions or verbs in URLs.
This article presents comprehensive guidelines for designing robust, secure, and maintainable enterprise services, covering API path conventions, request handling, input/output parameter design, business logic recommendations, exception handling, dependency management, monitoring, degradation strategies, encryption, and system admission practices.
This article outlines comprehensive best‑practice guidelines for designing robust, secure, and maintainable backend services—covering API path conventions, request handling, parameter design, error codes, dependency management, monitoring, degradation strategies, legacy service handling, encryption, access control, and tamper‑proof mechanisms, with practical code examples.
This article explains how to design a unified API response format in Spring Boot, defining a JSON result structure with code, message, and data, organizing status codes, using @ResponseResult annotation, implementing interceptors and ResponseBodyAdvice to automatically wrap controller outputs, and offers optimization tips for clean backend development.
This article presents comprehensive guidelines for designing flexible, secure, and maintainable API services, covering standardized paths, request handling, parameter design, business logic, exception management, dependency classification, monitoring, degradation strategies, handling legacy services, and encryption measures to ensure robust service architecture.
This article explores essential service design considerations beyond standard guidelines, covering API path structuring, request handling, parameter design, security measures, monitoring, degradation strategies, and code examples to help build flexible, secure, and maintainable backend services.
The article explains how defensive programming extends beyond simple input checks to include comprehensive data validation, parameter verification, illegal data handling, and collaborative design practices that protect systems from both code errors and external misuse.
This article presents a comprehensive design of a unified WebSocket communication service that abstracts messaging, improves reliability with RabbitMQ, replaces polling with push, and provides standardized APIs and message formats for backend developers to quickly integrate real‑time features.
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.
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.
This article introduces the concepts and core principles of RESTful APIs and provides a step‑by‑step Python Flask tutorial, including environment setup, code examples for CRUD operations, and guidance on testing, authentication, error handling, and versioning.
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.
This article reviews traditional Spring MVC controller definitions, introduces the new @HttpExchange annotation introduced in Spring 6 for declaring HTTP interfaces, demonstrates its usage with code examples, and shows how to generate client proxies for type‑safe HTTP calls.
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.
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.
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.
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.
This article explains the concept of idempotency, why it is crucial for distributed and API-driven systems, and provides a step‑by‑step guide to implementing idempotent operations using anti‑duplicate tokens to avoid issues such as repeated order submissions.
