Tagged articles

API Design

322 articles · Page 4 of 4
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 DesignBackenddata dictionary
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 DesignBest PracticesJavaScript
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 DesignBackendJSON
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 DesignBest Practicesdocumentation
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 DesignOAuthRESTful
0 likes · 15 min read
Mastering RESTful Architecture: From Resources to OAuth Authentication
Java High-Performance Architecture
Java High-Performance Architecture
Apr 26, 2016 · Backend Development

Avoid the Top 2 Performance Pitfalls: Logging and API Design

This article highlights the two most critical performance mistakes identified by Martin Thompson—excessive logging and poorly designed APIs—illustrating how logging threads can linearly increase latency and proposing better API signatures such as returning iterators or using caller‑provided collections to boost efficiency.

API DesignBackendJava
0 likes · 3 min read
Avoid the Top 2 Performance Pitfalls: Logging and API Design
MaGe Linux Operations
MaGe Linux Operations
Apr 9, 2016 · Cloud Native

The Real Challenge of Microservices: Service Splitting and Building a Cloud‑Native Platform

The article explores the multiple demands on internet systems, explains why business service granularity is the biggest obstacle to microservice adoption, and shares practical insights on designing a cloud‑native platform with Docker, Kubernetes, unified monitoring, API governance, and multi‑tenant resource isolation.

API DesignDockerKubernetes
0 likes · 10 min read
The Real Challenge of Microservices: Service Splitting and Building a Cloud‑Native Platform
21CTO
21CTO
Feb 24, 2016 · Backend Development

Designing Robust RESTful APIs: Best Practices and Guidelines

This article explains how to design a well‑structured RESTful API by covering protocol choice, domain naming, versioning, endpoint conventions, HTTP verbs, filtering, status codes, error handling, response formats, hypermedia links, authentication, and data format recommendations.

API DesignHTTP verbsRESTful API
0 likes · 9 min read
Designing Robust RESTful APIs: Best Practices and Guidelines
ITPUB
ITPUB
Dec 22, 2015 · User Experience Design

How to Build a Great Developer Experience (DX) for Your APIs

This article explains why developer experience matters for API products, defines DX, outlines empathy‑driven principles, and provides concrete guidelines—clear documentation, easy onboarding, robust debugging tools, supportive channels, and community‑focused practices—to help API designers create more appealing and competitive services.

API DesignDeveloper RelationsUX
0 likes · 11 min read
How to Build a Great Developer Experience (DX) for Your APIs
21CTO
21CTO
Aug 29, 2015 · Backend Development

How to Prevent Service Failures: Trust Third‑Party, Guard Users, Master Your Own Code

An experienced backend engineer shares practical strategies to prevent service failures, covering third‑party distrust, user‑side safeguards, robust API design, traffic limiting, resource management, and architectural best practices such as single‑responsibility and avoiding single points of failure.

API DesignSingle Responsibilityfault tolerance
0 likes · 16 min read
How to Prevent Service Failures: Trust Third‑Party, Guard Users, Master Your Own Code
21CTO
21CTO
Aug 10, 2015 · Backend Development

Designing Practical RESTful APIs: Best Practices for Real‑World Apps

This article presents practical guidelines for designing, versioning, securing, and documenting RESTful APIs, covering resource modeling, URL conventions, filtering, sorting, pagination, authentication, rate limiting, error handling, and response formats to help developers build flexible and user‑friendly public APIs.

API DesignBackendHTTP
0 likes · 22 min read
Designing Practical RESTful APIs: Best Practices for Real‑World Apps
Architect
Architect
Jul 11, 2015 · Backend Development

From Zero to One: Architecture and Development Practices of the Meiya Beauty Video Community

The article shares Meiya's journey from a small startup to a full‑featured beauty video platform, detailing common early‑stage challenges, communication and protocol strategies, RESTful API design, development workflow, toolchain choices like Laravel, DB migrations, iOS libraries, ELK logging, and DevOps automation with SaltStack.

API DesignDevOpsELK
0 likes · 12 min read
From Zero to One: Architecture and Development Practices of the Meiya Beauty Video Community
Art of Distributed System Architecture Design
Art of Distributed System Architecture Design
Mar 3, 2015 · Backend Development

A Seven‑Step Methodology for Designing Web APIs

This article outlines a repeatable, seven‑step process for designing robust Web APIs that leverages both HTTP and broader Web protocols, covering everything from listing semantic descriptors to publishing the API, and emphasizes clear separation of design and implementation details for future extensibility.

API DesignRESTWeb API
0 likes · 18 min read
A Seven‑Step Methodology for Designing Web APIs
Qunar Tech Salon
Qunar Tech Salon
Jan 14, 2015 · Backend Development

A Seven‑Step Methodology for Designing, Implementing, and Maintaining Web APIs

This article presents a comprehensive, seven‑step methodology for designing, implementing, and maintaining Web APIs—covering business use‑case definition, semantic description, state‑diagram modeling, naming harmonization, media‑type selection, semantic archive creation, coding, and publishing—while offering interviews and further reading recommendations.

API DesignBackendHTTP
0 likes · 18 min read
A Seven‑Step Methodology for Designing, Implementing, and Maintaining Web APIs
Qunar Tech Salon
Qunar Tech Salon
Nov 19, 2014 · Fundamentals

Characteristics of Good Interfaces and Core Design Principles

The article outlines the essential traits of high‑quality interfaces, describes a step‑by‑step process for designing and implementing them, and presents fundamental principles for interface, class, and method design to ensure usability, maintainability, and robustness in software development.

API DesignBest Practicesinterface design
0 likes · 4 min read
Characteristics of Good Interfaces and Core Design Principles