api-design Skill
Guide for designing and documenting RESTful APIs. Use when asked to design an API, create endpoints, or document an API. Published by microsoft in haste.
What is api-design Skill?
Guide for designing and documenting RESTful APIs. Use when asked to design an API, create endpoints, or document an API. Published by microsoft in haste. This profile combines repository metadata with install, compatibility, and usage signals so developers can quickly decide whether it fits their agent workflow before opening the source repository.
Automated repository signals based on public metadata such as recency, license, installation evidence, and adoption. These are not a security audit or endorsement.
Key capabilities
- Includes SKILL.md support
- Reusable instructions support
- Documentation
- Design and media
- Documentation use cases
- Design and media use cases
Technical details
- Install or run with Copy skill directory
When to use api-design Skill
- Use it for documentation.
- Use it for design and media.
Built with
Editorial notes
Source
- Creator: microsoft
- Repository: microsoft/haste
- Skill file: .github/skills/api-design/SKILL.md
What it does
Guide for designing and documenting RESTful APIs. Use when asked to design an API, create endpoints, or document an API.
Skill instructions
API Design Overview Standards and patterns for designing consistent, well-documented RESTful APIs. Covers naming, HTTP methods, error handling, status codes, and documentation requirements. Key Concepts Naming Conventions - Plural nouns for resources: /users, /orders, /products - Kebab-case for multi-word: /user-profiles - Nest related resources: /users/{id}/orders - Query params for filtering: /users?role=admin&active=true HTTP Methods | Method | Purpose | Idempotent | Response | |--------|---------|------------|----------| | GET | Read | Yes | 200 + body | | POST | Create | No | 201 + body + Location | | PUT | Replace | Yes | 200 + body | | PATCH | Partial update | No | 200 + body | | DELETE | Remove | Yes | 204 (no body) | Error Response Format json { "error": { "code": "VALIDATIONERROR", "message": "Human-readable description", "details": [ {"field": "email", "message": "Invalid email format"} ] } } Status Codes - 200: Success — 201: Created — 204: No content - 400: Bad request — 4
Explore related resources
Frequently asked questions
What is api-design?
api-design is a open-source AI agent skill with Copy skill directory. Guide for designing and documenting RESTful APIs. Use when asked to design an API, create endpoints, or document an API.
Who is api-design best for?
api-design is best for reusing agent instructions, scripts, and references, documentation workflows, design and media workflows.
How do I install api-design?
Install or run api-design using Copy skill directory. Check api-design for the latest setup command.
Is api-design actively maintained?
api-design may need a closer maintenance check before production use.
Auto-fetched from GitHub.
