api-interface-design
OfficialDefine RESTful APIs consistently and clearly.
System Documentation
What problem does it solve?
Design teams often struggle with inconsistent API designs across services, causing integration friction and poor developer experience. This Skill provides a unified RESTful API design standard, guiding resource modeling, URL naming, HTTP methods, error codes, and versioning to ensure coherence across projects.
Core Features & Use Cases
- RESTful API design principles and best practices
- URL naming conventions and resource modeling
- Consistent error codes and versioning schemes
- Reference templates for interface contracts and documentation
- Suitable for API reviews, interface definition, and documentation tasks
Quick Start
Define a new API endpoint following the guidelines: determine scope, map to a resource, choose an HTTP method, craft request and response structures, and assign standardized error codes. Use the examples for a user-facing pipeline resource at /user/pipelines with a paginated list and a suitable info response. Ensure the interface contracts are documented in Swagger/OpenAPI with versioning considerations.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: api-interface-design Download link: https://github.com/TencentBlueKing/bk-ci/archive/main.zip#api-interface-design Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.