Skip to main content 首页 创作者 seaworld008 commonly-used-high-value-skills api-design-reviewer
api-design-reviewer Use when reviewing API designs for consistency, usability, versioning, error semantics, security, backward compatibility, and developer experience before implementation or release.
跳到安装 Skills Marketplace 发现并探索由社区构建的 Agent Skills
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
直接命令不会经过审查 Prompt；运行前请先检查来源。
npx skills add https://github.com/seaworld008/Commonly-used-high-value-skills --skill api-design-reviewer命令会保持在同一行。复制前请横向滚动并检查完整内容。
想先保存到本地？可下载 SkillsMP 当前能够提供的文件。
下载 Zip 下载中... 同仓库更多 Skills Multi-agent collaboration plugin that spawns N parallel subagents competing on the same task via git worktree isolation. Agents work independently, results are evaluated by metric or LLM judge, and the best branch is merged. Use when: user wants multiple approaches tried in parallel — code optimization, content variation, research exploration, or any task that benefits from parallel competition. Requires: a git repo.
Design production-grade multi-agent orchestration systems. Covers five core patterns (sequential pipeline, parallel fan-out/fan-in, hierarchical delegation, event-driven, consensus), platform-specific implementations, handoff protocols, state management, error recovery, context window budgeting, and cost optimization.
App Store Optimization toolkit for researching keywords, optimizing metadata, and tracking mobile app performance on Apple App Store and Google Play Store.
seaworld008
seaworld008/Commonly-used-high-value-skills
打开 GitHub 仓库 name api-design-reviewer description Use when reviewing API designs for consistency, usability, versioning, error semantics, security, backward compatibility, and developer experience before implementation or release. zh_description 用于评审 API 设计的一致性、可用性、版本策略、错误语义、安全性和开发者体验。 version 1.0.0 author seaworld008 source in-house source_url tags ["api", "design", "development", "reviewer"] created_at 2026-03-04 updated_at 2026-06-29 quality 5 complexity intermediate
API Design Reviewer
Tier: POWERFULCategory: Engineering / ArchitectureMaintainer: Claude Skills Team
Overview
The API Design Reviewer skill provides comprehensive analysis and review of API designs, focusing on REST conventions, best practices, and industry standards. This skill helps engineering teams build consistent, maintainable, and well-designed APIs through automated linting, breaking change detection, and design scorecards.
Core Capabilities
1. API Linting and Convention Analysis
Resource Naming Conventions : Enforces kebab-case for resources, camelCase for fieldsHTTP Method Usage : Validates proper use of GET, POST, PUT, PATCH, DELETEURL Structure : Analyzes endpoint patterns for consistency and RESTful designStatus Code Compliance : Ensures appropriate HTTP status codes are usedError Response Formats : Validates consistent error response structuresDocumentation Coverage : Checks for missing descriptions and documentation gaps
2. Breaking Change Detection
Endpoint Removal : Detects removed or deprecated endpointsResponse Shape Changes : Identifies modifications to response structuresField Removal : Tracks removed or renamed fields in API responsesType Changes : Catches field type modifications that could break clientsRequired Field Additions : Flags new required fields that could break existing integrationsStatus Code Changes : Detects changes to expected status codes
3. API Design Scoring and Assessment
Consistency Analysis (30%): Evaluates naming conventions, response patterns, and structural consistencyDocumentation Quality (20%): Assesses completeness and clarity of API documentationSecurity Implementation (20%): Reviews authentication, authorization, and security headersUsability Design (15%): Analyzes ease of use, discoverability, and developer experiencePerformance Patterns (15%): Evaluates caching, pagination, and efficiency patterns
REST Design Principles
Resource Naming Conventions
✅ Good Examples:
- /api/v1/users
- /api/v1/user-profiles
- /api/v1/orders/123/line-items
❌ Bad Examples:
- /api/v1/getUsers
- /api/v1/user_profiles
- /api/v1/orders/123/lineItems
HTTP Method Usage
GET : Retrieve resources (safe, idempotent)POST : Create new resources (not idempotent)PUT : Replace entire resources (idempotent)PATCH : Partial resource updates (not necessarily idempotent)DELETE : Remove resources (idempotent)
URL Structure Best Practices Collection Resources: /api/v1/users
Individual Resources: /api/v1/users/123
Nested Resources: /api/v1/users/123/orders
Actions: /api/v1/users/123/activate (POST)
Filtering: /api/v1/users?status=active&role=admin
Versioning Strategies
1. URL Versioning (Recommended) /api/v1/users
/api/v2/users
Pros : Clear, explicit, easy to routeCons : URL proliferation, caching complexity
2. Header Versioning GET /api/users
Accept: application/vnd.api+json;version=1
Pros : Clean URLs, content negotiationCons : Less visible, harder to test manually
3. Media Type Versioning GET /api/users
Accept: application/vnd.myapi.v1+json
Pros : RESTful, supports multiple representationsCons : Complex, harder to implement
4. Query Parameter Versioning Pros : Simple to implementCons : Not RESTful, can be ignored
Pagination Patterns
Offset-Based Pagination {
"data" : [ ...] ,
"pagination" : {
"offset" : 20 ,
"limit" : 10 ,
"total" : 150 ,
"hasMore" : true }
}
Cursor-Based Pagination {
"data" : [ ...] ,
"pagination" : {
"nextCursor" : "eyJpZCI6MTIzfQ==" ,
"hasMore" : true }
}
Page-Based Pagination {
"data" : [ ...] ,
"pagination" : {
"page" : 3 ,
"pageSize" : 10 ,
"totalPages" : 15 ,
"totalItems" : 150
}
}
Error Response Formats
Standard Error Structure {
"error" : {
"code" : "VALIDATION_ERROR" ,
"message" : "The request contains invalid parameters" ,
"details" : [
{
"field" : "email" ,
"code" : "INVALID_FORMAT" ,
"message" : "Email address is not valid"
}
] ,
"requestId" : "req-123456" ,
"timestamp" : "2024-02-16T13:00:00Z"
}
}
HTTP Status Code Usage
400 Bad Request : Invalid request syntax or parameters401 Unauthorized : Authentication required403 Forbidden : Access denied (authenticated but not authorized)404 Not Found : Resource not found409 Conflict : Resource conflict (duplicate, version mismatch)422 Unprocessable Entity : Valid syntax but semantic errors429 Too Many Requests : Rate limit exceeded500 Internal Server Error : Unexpected server error
Authentication and Authorization Patterns
Bearer Token Authentication Authorization: Bearer <token>
API Key Authentication X-API-Key: <api-key>
Authorization: Api-Key <api-key>
OAuth 2.0 Flow Authorization: Bearer <oauth-access-token>
Role-Based Access Control (RBAC) {
"user" : {
"id" : "123" ,
"roles" : [ "admin" , "editor" ] ,
"permissions" : [ "read:users" , "write:orders" ]
}
}
Rate Limiting Implementation
Headers X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200
Response on Limit Exceeded {
"error" : {
"code" : "RATE_LIMIT_EXCEEDED" ,
"message" : "Too many requests" ,
"retryAfter" : 3600
}
}
HATEOAS (Hypermedia as the Engine of Application State)
Example Implementation {
"id" : "123" ,
"name" : "John Doe" ,
"email" : "john@example.com" ,
"_links" : {
"self" : { "href" : "/api/v1/users/123" } ,
"orders" : { "href" : "/api/v1/users/123/orders" } ,
"profile" : { "href" : "/api/v1/users/123/profile" } ,
"deactivate" : {
"href" : "/api/v1/users/123/deactivate" ,
"method" : "POST"
}
}
}
Idempotency
Idempotent Methods
GET : Always safe and idempotentPUT : Should be idempotent (replace entire resource)DELETE : Should be idempotent (same result)PATCH : May or may not be idempotent
Idempotency Keys POST /api/v1/payments
Idempotency-Key: 123e4567-e89b-12d3-a456-426614174000
Backward Compatibility Guidelines
Safe Changes (Non-Breaking)
Adding optional fields to requests
Adding fields to responses
Adding new endpoints
Making required fields optional
Adding new enum values (with graceful handling)
Breaking Changes (Require Version Bump)
Removing fields from responses
Making optional fields required
Changing field types
Removing endpoints
Changing URL structures
Modifying error response formats
OpenAPI/Swagger Validation
Required Components
API Information : Title, description, versionServer Information : Base URLs and descriptionsPath Definitions : All endpoints with methodsParameter Definitions : Query, path, header parametersRequest/Response Schemas : Complete data modelsSecurity Definitions : Authentication schemesError Responses : Standard error formats
Best Practices
Use consistent naming conventions
Provide detailed descriptions for all components
Include examples for complex objects
Define reusable components and schemas
Validate against OpenAPI specification
Performance Considerations
Caching Strategies Cache-Control: public, max-age=3600
ETag: "123456789"
Last-Modified: Wed, 21 Oct 2015 07:28:00 GMT
Efficient Data Transfer
Use appropriate HTTP methods
Implement field selection (?fields=id,name,email)
Support compression (gzip)
Implement efficient pagination
Use ETags for conditional requests
Resource Optimization
Avoid N+1 queries
Implement batch operations
Use async processing for heavy operations
Support partial updates (PATCH)
Security Best Practices
Input Validation
Validate all input parameters
Sanitize user data
Use parameterized queries
Implement request size limits
Authentication Security
Use HTTPS everywhere
Implement secure token storage
Support token expiration and refresh
Use strong authentication mechanisms
Authorization Controls
Implement principle of least privilege
Use resource-based permissions
Support fine-grained access control
Audit access patterns
Tools and Scripts
api_linter.py Analyzes API specifications for compliance with REST conventions and best practices.
OpenAPI/Swagger spec validation
Naming convention checks
HTTP method usage validation
Error format consistency
Documentation completeness analysis
breaking_change_detector.py Compares API specification versions to identify breaking changes.
Endpoint comparison
Schema change detection
Field removal/modification tracking
Migration guide generation
Impact severity assessment
api_scorecard.py Provides comprehensive scoring of API design quality.
Multi-dimensional scoring
Detailed improvement recommendations
Letter grade assessment (A-F)
Benchmark comparisons
Progress tracking
Integration Examples
CI/CD Integration - name: API Linting
run: python scripts/api_linter.py openapi.json
- name: Breaking Change Detection
run: python scripts/breaking_change_detector.py openapi-v1.json openapi-v2.json
- name: API Scorecard
run: python scripts/api_scorecard.py openapi.json
Pre-commit Hooks #!/bin/bash
python engineering/api-design-reviewer/scripts/api_linter.py api/openapi.json
if [ $? -ne 0 ]; then
echo "API linting failed. Please fix the issues before committing."
exit 1
fi
Best Practices Summary
Consistency First : Maintain consistent naming, response formats, and patternsDocumentation : Provide comprehensive, up-to-date API documentationVersioning : Plan for evolution with clear versioning strategiesError Handling : Implement consistent, informative error responsesSecurity : Build security into every layer of the APIPerformance : Design for scale and efficiency from the startBackward Compatibility : Minimize breaking changes and provide migration pathsTesting : Implement comprehensive testing including contract testingMonitoring : Add observability for API usage and performanceDeveloper Experience : Prioritize ease of use and clear documentation
Common Anti-Patterns to Avoid
Verb-based URLs : Use nouns for resources, not actionsInconsistent Response Formats : Maintain standard response structuresOver-nesting : Avoid deeply nested resource hierarchiesIgnoring HTTP Status Codes : Use appropriate status codes for different scenariosPoor Error Messages : Provide actionable, specific error informationMissing Pagination : Always paginate list endpointsNo Versioning Strategy : Plan for API evolution from day oneExposing Internal Structure : Design APIs for external consumption, not internal convenienceMissing Rate Limiting : Protect your API from abuse and overloadInadequate Testing : Test all aspects including error cases and edge conditions
Conclusion The API Design Reviewer skill provides a comprehensive framework for building, reviewing, and maintaining high-quality REST APIs. By following these guidelines and using the provided tools, development teams can create APIs that are consistent, well-documented, secure, and maintainable.
Regular use of the linting, breaking change detection, and scoring tools ensures continuous improvement and helps maintain API quality throughout the development lifecycle.
