skills.rest
narumikr
narumikrCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

api-design

Guide RESTful API design and review with best practices for URIs, methods, and status codes.

2|Updated Jan 8, 2026
Search Tags:#restful#api design#status codes#http methods#api best practices#api review
One-click install
npx skills add https://github.com/narumikr/ai-hackathon-4th --skill api-design-narumikr
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/narumikr/ai-hackathon-4th/tree/main/.claude/skills/api-design
Command: npx skills add https://github.com/narumikr/ai-hackathon-4th --skill api-design-narumikr

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) and templates (resource) components.

What problem does it solve?

This Skill helps you design and review RESTful APIs, ensuring they are robust, scalable, and follow best practices, preventing common pitfalls and improving developer experience.

Core Features & Use Cases

  • API Design Guidance: Provides principles for resource naming, URI structure, and HTTP method usage.
  • Best Practice Enforcement: Offers checklists and examples for status codes, error handling, and versioning.
  • Review Assistance: Helps identify and correct anti-patterns in API design.
  • Use Case: You're building a new microservice and need to define its API endpoints. Use this Skill to ensure your design is clean, consistent, and maintainable from the start.

Quick Start

Use the api-design skill to review the following endpoint: GET /api/v1/users/{user_id}/profile.

Frequently Asked Questions about api-design

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I design a RESTful API with proper resource naming and URI structure?▼

To design a RESTful API, use resource-oriented naming, consistent URI structures, and correct HTTP methods. This Skill provides principles and templates to ensure your endpoints are clean, maintainable, and follow best practices from the start.

What are the best practices for HTTP status codes and error handling in API design?▼

Best practices for HTTP status codes and error handling involve using standard codes consistently and structuring clear error responses. This Skill offers checklists and examples to enforce these conventions, ensuring a robust and developer-friendly experience.

How can I review my existing API endpoints for anti-patterns?▼

Reviewing API endpoints for anti-patterns involves checking resource design, HTTP method usage, and versioning strategies against established standards. This Skill helps identify and correct common pitfalls to improve your API specifications.

What is the best way to handle API versioning strategies for microservices?▼

Handling API versioning strategies requires defining clear rules for updating endpoints without breaking clients. This Skill provides guidance on implementing versioning alongside error handling and status codes to maintain scalable microservices.

Can I use this to check if my API design is consistent before building a new microservice?▼

Yes, you can use this Skill to verify API design consistency before building a new microservice. It provides review assistance and best practice enforcement to ensure your specifications are well-structured and maintainable.

Related Skills

Explore More Software Engineering Skills→
tinkermonkeytinkermonkey

LAYER_07_DATA_MODEL

Define and validate object data structures using JSON Schema Draft 7.

Community
Advanced
microwindmicrowind
65

api-contract-validator

Validate OpenAPI, Swagger, and GraphQL contracts for breaking changes.

Official
Advanced
roanbrasilroanbrasil
5

api-gateway-design

Configure API gateways with authentication, rate limiting, and routing.

Community
Advanced
yusufcmgyusufcmg
1

api-design-principles

Guide REST and GraphQL API design with patterns and best practices.

Community
Intermediate