Skill

api-design

Designs RESTful API endpoints with URL structures, HTTP methods, request/response schemas, OpenAPI specs, status codes, and best practices checks. Useful for new APIs or endpoint refactoring.

REST API

OpenAPI

api-development

documentation

npx claudepluginhub sunnypatneedi/claude-starter-kit

Tool Access

This skill uses the workspace's default tool permissions.

Preview

Help me design a RESTful API:

SKILL.md

Similar Skills

api-design

Guides RESTful API design and implementation: resource naming, HTTP methods, URL patterns, error responses, versioning, and core principles.

5 files

conductor

api

Designs REST, GraphQL, gRPC APIs via resource modeling, endpoint catalogs, and OpenAPI specs. Validates designs, suggests versioning, and handles discovery/context.

1 file

godmode

api-designer

Designs consistent RESTful APIs covering conventions, HTTP methods, naming, versioning strategies, response formats, status codes, error handling, and pagination patterns.

aura-frog

Stats

Stars5

Forks1

Last CommitJan 23, 2026

Actions

View Source View Plugin View on GitHub View README

Help us improve

Share bugs, ideas, or general feedback.

API Design

Help me design a RESTful API:

Requirements

Resource: What entity is this for?
Operations: What actions are needed (CRUD, other)?
Relationships: How does it relate to other resources?
Users: Who will call this API?

Endpoint Design

For each operation, define:

URL Structure

Resource path (nouns, plural)
Parameter placement
Query parameters for filtering/sorting

HTTP Methods

GET for reads
POST for creates
PUT/PATCH for updates
DELETE for removes

Request Format

Request body schema
Required vs optional fields
Validation rules

Response Format

Success response schema
Pagination structure (if list)
Error response format

Status Codes

2xx for success
4xx for client errors
5xx for server errors

Documentation

Generate OpenAPI/Swagger spec including:

Endpoint descriptions
Parameter definitions
Schema definitions
Example requests/responses

Best Practices Check

Verify the design follows:

RESTful conventions
Consistent naming
Proper status codes
Security considerations