惯性聚合 高效追踪和阅读你感兴趣的博客、新闻、科技资讯
阅读原文 在惯性聚合中打开

推荐订阅源

月光博客
月光博客
freeCodeCamp Programming Tutorials: Python, JavaScript, Git & More
N
Netflix TechBlog - Medium
大猫的无限游戏
大猫的无限游戏
爱范儿
爱范儿
Martin Fowler
Martin Fowler
OSCHINA 社区最新新闻
OSCHINA 社区最新新闻
The Register - Security
The Register - Security
IT之家
IT之家
博客园_首页
Microsoft Security Blog
Microsoft Security Blog
钛媒体:引领未来商业与生活新知
钛媒体:引领未来商业与生活新知
博客园 - 三生石上(FineUI控件)
I
InfoQ
CTFtime.org: upcoming CTF events
CTFtime.org: upcoming CTF events
Jina AI
Jina AI
Apple Machine Learning Research
Apple Machine Learning Research
M
MIT News - Artificial intelligence
博客园 - Franky
C
Check Point Blog
T
The Blog of Author Tim Ferriss
V
Visual Studio Blog
Cyber Security Advisories - MS-ISAC
Cyber Security Advisories - MS-ISAC
T
Tailwind CSS Blog
Recent Announcements
Recent Announcements
云风的 BLOG
云风的 BLOG
美团技术团队
The Cloudflare Blog
Y
Y Combinator Blog
H
Hackread – Cybersecurity News, Data Breaches, AI and More
MyScale Blog
MyScale Blog
The GitHub Blog
The GitHub Blog
D
DataBreaches.Net
Google DeepMind News
Google DeepMind News
V
V2EX
aimingoo的专栏
aimingoo的专栏
GbyAI
GbyAI
G
Google Developers Blog
S
SegmentFault 最新的问题
Hugging Face - Blog
Hugging Face - Blog
奇客Solidot–传递最新科技情报
奇客Solidot–传递最新科技情报
U
Unit 42
罗磊的独立博客
量子位
MongoDB | Blog
MongoDB | Blog
Last Week in AI
Last Week in AI
Stack Overflow Blog
Stack Overflow Blog
小众软件
小众软件
D
Docker
人人都是产品经理
人人都是产品经理

DEV Community

Authentication Security Deep Dive: From Brute Force to Salted Hashing (With Java Examples) Why AI Systems Don’t Fail — They Drift Spilling beans for how i learn for exam😁"Reinforcement Learning Cheat Sheet" I Replaced Chrome with Safari for AI Browser Automation. Here's What Broke (and What Finally Worked) How Python Borrows Other People's Work The $40 Architecture: Processing 1 Billion API Requests with 99.99% Uptime Vibe Coding: A Workflow Guide (From Zero to SaaS) Most webhook security guides protect the wrong side. The scary part is delivery. Headless CMS for TanStack Start: Build a Blog with Cosmic EU Age Verification App "Hacked in 2 Minutes" — What Actually Happened Comfy Cloud’s delete function does not actually remove files Running AI Models on GPU Cloud Servers: A Beginner Guide Event-driven media intelligence with AWS Step Functions and Bedrock I scored 500 AI prompts across 8 quality dimensions — here's what broke How to Call Google Gemini API from Next.js (Free Tier, No Backend Needed) The Portal Protocol: Reclaiming Human Connection in the Age of AI How to Fix Your Team's Scattered Knowledge Problem With a Self-Hosted Forum Intro to tc Cloud Functors: A Graph-First Mental Model for the Modern Cloud Designing Multi-Tenant Backends With Both Ownership and Team Access I Built a Neumorphic CSS Library with 77+ Components — Here's What I Learned PostgreSQL Performance Optimization: Why Connection Pooling Is Critical at Scale Cómo construí un SaaS multi-rubro para gestionar expensas en Argentina con FastAPI + Vue 3 🚀 I Built an Ethical Hacking Scanner Tool – Open Source Project I Replaced /usage and /context in Claude Code With a Single Statusline A Pythonic Way to Handle Emails (IMAP/SMTP) with Auto-Discovery and AI-Ready Design I Collected 8.9 Million Polymarket Price Points — Here's What I Found About How Markets Really Move EcoTrack AI — Carbon Footprint Tracker & Dashboard Everyone's Using AI. No One Agrees How. 5 self-hosted ebook managers worth trying in 2026 Building Your First AI Agent with LangChain: From Chatbot to Autonomous Assistant Common SOC 2 Failures (Real World) Stop Vibe-Checking Your AI App: A Practical Guide to Evals How to Use SonarQube and SonarScanner Locally to Level Up Your Code Quality Your Next To-Do App Is Dead — I Replaced Mine with an OpenClaw AI Sign a Nostr event in 60 lines of Python using coincurve — no nostr-sdk, no nbxplorer, no rust toolchain ITGC Audit Explained Like You’re in Big 4 Patch Tuesday abril 2026: Microsoft parcha 163 vulnerabilidades y un zero-day en SharePoint Stop scraping everything: a better way to track competitor price changes Listing on MCPize + the Official MCP Registry while routing payments OUTSIDE the marketplace — how I kept 100% of my x402 revenue Building an AI-Powered Risk Intelligence System Using Serverless Architecture Why We Ripped Function Overloading Out of Our AI Toolchain Testing AI-Generated Code: How to Actually Know If It Works SaaS Churn Is Killing Your Business. Here Is What to Do About It (Without a Support Team) The Speed of AI Is No Longer Linear - And Self-Improving Models Are Why How to Implement RBAC for MCP Tools: A Practical Guide for Engineering Teams From Standard Quote to Persuasive Proposal: AI Automation for Arborists I built a CLI that scaffolds complete multi-tenant SaaS apps Axios CVE-2025–62718: The Silent SSRF Bug That Could Be Hiding in Your Node.js App Right Now The dashboard that ended our friendship Data Pipelines Explained Simply (and How to Build Them with Python) The Hidden Cost of AI Systems Nobody Talks About. undefined vs undeclared, and how typeof behaves Switching from file-based jobs to NATS/Kafka in Rust without changing code io_uring Adventures: Rust Servers That Love Syscalls Why Agentic AI is Killing the Traditional Database The POUR principles of web accessibility for developers and designers Quantum Neural Network 3D — A Deep Dive into Interactive WebGL Visualization How To Install Caveman In Codex On macOS And Windows Automation Pipeline Reliability: Why Your Workflow Breaks When Nobody Is Watching I Built an 'Open World' AI Coding Agent — It Works From ANY Folder From Freelancing to Product: A Tech Service Company's SaaS Transformation China's AI Giants: Adding Tencent Hunyuan & ByteDance Doubao to AI University (74 Providers) On the Vibe Coders and Their Lies clerk: Auto-Summarize Your Claude Code Sessions AI Weekly — 2026/04/10–04/17 | The Model Lockdown Is Here, but the Toolchain Is the Real Battleground AI 週報 — 2026/04/10–2026/04/17 模型封鎖潮來了,但工具鏈才是真戰場 Maybe this is how Open-Source apps are born... 🚀 Fine-Tune LLMs with LoRA and QLoRA: 2026 Guide tRPC v11 + Next.js App Router: End-to-End Type Safety Without the Boilerplate ShadCN UI in 2026: Why I Stopped Installing Component Libraries and Started Owning My Components SaaS Billing in React Server Components: Stripe + Supabase Without a Single `useEffect` Join our DEV Weekend Challenge — $1,000 in Prizes Across TEN winners! Submissions Due April 20 at 6:59 AM UTC. Implementing FSRS Spaced Repetition in Flutter + Supabase — Adding Memory Science to an AI Learning App "I Texted My Localhost From the Train — Claude Code Fixed the Bug Before I Got Home" I Built a Sales Prep AI and It Went Deeper Than Expected Design to Code #2: One JSON, Eleven Outputs Solving the 100M-Row Problem: A Summary Table Pattern for High-Volume Push Notification Logs Flutter Web With Wasm: What Actually Changes For Developers I Built 50 Royalty-Free Soundtracks for My Side Project in a Weekend Using AI Music Generation The Vibe Coding Security Checklist: 7 Things to Check Before You Ship Stop Letting Googlebot Guess Fix Your React App's SEO Right Desconstruindo o Streaming do LinkedIn: Como Criar um Engine de Extração de Vídeo de Alta Performance com HLS e FFmpeg (EDA Part-1) EDA (Exploratory Data Analysis) Explained With Real Life — Why Looking at Your Data Is the Most Important Step in Machine Learning Brand Relationship Management at Scale: Our 4-Touch Outreach System for 200+ Brands Why String.fromEnvironment() Might Return an Empty String in Dart JGuardrails 1.0.0 — Hardening Java LLM Apps Against Jailbreaks, Toxicity, and Prompt Injection Plan and Schedule a Full Week of Threads Content From One Claude Conversation Coding Cat Oran Ep3, Five Tables Changed Everything Updated: BFF Pattern I'm done watching freelancers get buried by 200 proposals. So I'm building the alternative. This is my first post BFS Algorithm in Java Step by Step Tutorial with Examples Tracking LLM Pricing Monthly: An Open Dataset for 22 AI Models How We Measure Content ROI on a Comparison Site: Revenue Attribution Without Perfect Data Introducing Nova AI Ops: The AI-Native Operating System for SRE Teams I built a free desktop video downloader for Windows — Grabbit How Talkie OCR Helps Vision-Impaired & Dyslexic Users Read the World Around Them VRCFaceTracking安装和iPhone面捕配置教程,有bug Even CrowdStrike Can't See Your Agents The Automation Gold Rush: What n8n Workflows and Claude Are Opening Up for Developers Right Now
REST API Design: Building APIs Developers Love (2026)
Alex Chen · 2026-05-27 · via DEV Community

Alex Chen

REST API Design: Building APIs Developers Love (2026)

A good API is like a good UI — intuitive, consistent, and a pleasure to use.

Core Principles

1. Consistency over cleverness
   → Same patterns everywhere
   → Predictable response shapes
   → No surprises

2. Resources, not actions
   → GET /users (not /getUsers)
   → POST /users (not /createUser)
   → Nouns, not verbs

3. Statelessness
   → Each request contains everything needed
   → Server doesn't store session state between requests
   → Scales horizontally

4. Practical defaults
   → JSON for request/response bodies
   → camelCase for JSON keys (JavaScript convention)
   → snake_case for URL parameters/headers (HTTP convention)

Enter fullscreen mode Exit fullscreen mode

URL Design

# Good: Resource-oriented, hierarchical

GET     /api/users                    # List all users
GET     /api/users?role=admin&sort=-createdAt  # Filtered/sorted list
POST    /api/users                    # Create user
GET     /api/users/:id                # Get specific user
PUT     /api/users/:id                # Full update
PATCH   /api/users/:id                # Partial update
DELETE  /api/users/:id                # Delete user

# Nested resources (relationships)
GET     /api/users/:id/orders         # User's orders
POST    /api/users/:id/orders         # Create order for user
GET     /api/users/:id/orders/:orderId  # Specific order

# Actions on resources (when CRUD doesn't fit)
POST    /api/users/:id/activate       # Activate account
POST    /api/users/:id/deactivate     # Deactivate
POST    /api/orders/:id/cancel        # Cancel order
POST    /api/orders/:id/refund        # Request refund

# Search (complex queries)
GET     /api/search?q=keyword&type=users
POST    /api/search                   # For complex filters (body > URL length)

# Bad URLs to avoid:
❌ /api/getAllUsers               # Verb in path
❌ /api/user-data                 # Inconsistent naming
❌ /api/users/1                   # Use :id pattern consistently
❌ /api/getUserById?id=1          # Query params for required IDs
❌ /api/v2/new-users              # Version in weird places

Enter fullscreen mode Exit fullscreen mode

HTTP Methods: The Standard Mapping

Method Safe Idempotent Meaning Example
GET Read resource Get user profile
HEAD Like GET, no body Check if exists
POST Create resource New user
PUT Replace entirely Update full profile
PATCH Partial update Change email only
DELETE Remove resource Delete account
OPTIONS CORS preflight Browser auto-sends

Key concepts:

  • Safe: Doesn't modify server state (GET is safe)
  • Idempotent: Same request = same result (PUT same data twice = identical outcome; POST creates TWO resources)

Response Format

Success Responses

// Single resource
{
  "success": true,
  "data": {
    "id": "usr_abc123",
    "email": "user@example.com",
    "name": "Alice",
    "role": "user",
    "createdAt": "2026-05-27T10:33:00Z",
    "updatedAt": "2026-05-27T10:33:00Z"
  }
}

// Collection with pagination
{
  "success": true,
  "data": [
    { "id": "usr_001", "name": "Alice" },
    { "id": "usr_002", "name": "Bob" }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "totalPages": 8,
    "hasNext": true,
    "hasPrev": false
  }
}

// Created (201)
{
  "success": true,
  "data": { "id": "usr_new123", ... },
  "message": "User created successfully"
}

// No content (204)
// Response body is empty (for successful DELETE)

Enter fullscreen mode Exit fullscreen mode

Error Responses

// Client error (4xx)
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Validation failed",
    "details": [
      { "field": "email", "issue": "Invalid email format" },
      { "field": "password", "issue": "Must be at least 8 characters" }
    ],
    "requestId": "req_abc123"
  }
}

// Not found (404)
{
  "error": {
    "code": "NOT_FOUND",
    "message": "User not found (id: usr_xyz)",
    "requestId": "req_abc123"
  }
}

// Server error (500)
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "An internal error occurred",
    "requestId": "req_abc123"
    // Never expose stack traces or internals in production!
  }
}

Enter fullscreen mode Exit fullscreen mode

Error Code Standards

// Use consistent, machine-readable error codes:
const ERROR_CODES = {
  // Client errors (4xx)
  BAD_REQUEST: 'BAD_REQUEST',
  UNAUTHORIZED: 'UNAUTHORIZED',
  FORBIDDEN: 'FORBIDDEN',
  NOT_FOUND: 'NOT_FOUND',
  NOT_ACCEPTABLE: 'NOT_ACCEPTABLE',           // 406
  CONFLICT: 'CONFLICT',                       // 409
  VALIDATION_ERROR: 'VALIDATION_ERROR',        // 422
  RATE_LIMITED: 'RATE_LIMITED',                // 429

  // Server errors (5xx)
  INTERNAL_ERROR: 'INTERNAL_ERROR',
  SERVICE_UNAVAILABLE: 'SERVICE_UNAVAILABLE', // 503
  TIMEOUT: 'TIMEOUT',                          // 504 (gateway timeout)
};

Enter fullscreen mode Exit fullscreen mode

Query Parameters & Filtering

// Standard pagination
GET /api/users?page=2&limit=20
// page starts at 1, default limit = 20

// Sorting
GET /api/users?sort=createdAt          // Ascending
GET /api/users?sort=-createdAt         // Descending (- prefix)
GET /api/users?sort=name,-createdAt   // Multi-sort

// Filtering
GET /api/users?role=admin             // Exact match
GET /api/users?status=active,pending  // Multiple values (OR)
GET /api/users?minAge=18&maxAge=65     // Range filter
GET /api/users?search=alice            // Full-text search
GET /api/users?tags=javascript,node   // Has ALL tags (AND)

// Field selection (reduce payload)
GET /api/users?fields=id,name,email    // Only return these fields
GET /api/users?exclude=passwordHash,lastLogin  // Exclude sensitive fields

// Include related resources
GET /api/users/:id?include=orders,profile  // Eager load relations

// Server-side implementation:
function parseQuery(req) {
  return {
    page: Math.max(1, parseInt(req.query.page) || 1),
    limit: Math.min(100, parseInt(req.query.limit) || 20), // Cap at 100
    sort: req.query.sort || '-createdAt',
    search: req.query.search,
    fields: req.query.fields?.split(','),
    include: req.query.include?.split(','),
    // ... build filters from remaining query params
  };
}

Enter fullscreen mode Exit fullscreen mode

Versioning Your API

Three approaches:

1. URL Path Versioning (most common)
   /api/v1/users
   /api/v2/users
   Pros: Clear, works with CDNs, easy to deprecate
   Cons: URL clutter

2. Header Versioning
   Accept: application/vnd.api.v2+json
   Pros: Clean URLs
   Cons: Harder to debug in browser, not obvious

3. No Versioning (just evolve)
   /api/users
   Pros: Simplest
   Cons: Breaking changes break clients

My recommendation: Start with URL versioning.
Only add v1 when you have real users and need stability guarantees.

Enter fullscreen mode Exit fullscreen mode

Authentication Patterns

// Pattern 1: Bearer Token (JWT) — Most common for APIs
Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

// Pattern 2: API Key — For server-to-server or public APIs
X-API-Key: sk_live_abc123
// Or query param: ?api_key=sk_live_abc123 (less secure but simpler)

// Pattern 3: OAuth 2.0 — For third-party access
Authorization: Bearer oauth_access_token_here

// Response should include auth info when relevant:
{
  "data": { /* ... */ },
  "meta": {
    "scopes": ["read:profile", "write:profile"],
    "rateLimit": { "remaining": 95, "reset": "2026-05-27T11:00:00Z" }
  }
}

Enter fullscreen mode Exit fullscreen mode

Rate Limiting Done Right

// Headers on EVERY response (even errors!):
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 73
X-RateLimit-Reset: 1716825600      // Unix timestamp
Retry-After: 60                      // On 429 responses

// Rate limit tiers (common pattern):
// Unauthenticated: 30/hour
// Authenticated (free): 100/hour
// Paid tier: 1000/hour
// Admin: unlimited

// Always include rate limit info in response body on 429:
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Too many requests. Please try again later.",
    "retryAfter": 45,
    "rateLimit": {
      "limit": 100,
      "remaining": 0,
      "resetAt": "2026-05-27T11:00:00Z"
    }
  }
}

Enter fullscreen mode Exit fullscreen mode

Documentation

Your API is only as good as its documentation.

Minimum requirements:
→ Every endpoint documented
→ Request/response examples for each
→ Authentication explanation
→ Error codes reference
→ Rate limits stated
→ SDK/client library examples

Tools I recommend:
→ OpenAPI/Swagger (auto-generate interactive docs)
→ Postman Collections (shareable, importable)
→ README.md with quick-start guide (always!)

The best API docs let developers succeed WITHOUT contacting you.

Enter fullscreen mode Exit fullscreen mode

Quick Checklist

Before shipping any endpoint:

□ Uses correct HTTP method (GET/POST/PATCH/PUT/DELETE)
□ URL follows resource-naming convention
□ Returns consistent response shape ({ success, data/error })
□ Handles pagination for collections
□ Validates input and returns 422 with details
□ Returns 404 (not 500) for missing resources
□ Includes rate limit headers
□ Has authentication where needed
□ Returns appropriate status codes
□ Documented with examples
□ Error messages are helpful (not exposing internals)
□ Request ID included for support debugging
□ Fields use consistent naming (camelCase in JSON body)

Enter fullscreen mode Exit fullscreen mode


What's the best/worst API you've worked with?

Follow @armorbreak for more practical developer guides.