code-design-api

Design API contracts, schemas, and specifications before implementation.

Safety Notice

This listing is imported from skills.sh public index metadata. Review upstream SKILL.md and repository scripts before running.

Copy this and send it to your AI assistant to learn

Install skill "code-design-api" with this command: npx skills add sirn/dotfiles/sirn-dotfiles-code-design-api

Design API contracts, schemas, and specifications before implementation.

Process

Identify context:

  • Protocol: REST, GraphQL, gRPC, TRPC

  • Format: OpenAPI/Swagger, Protocol Buffers, Zod/TypeBox schemas

Research and design:

  • Lookup best practices for the protocol (use WebSearch/WebFetch)

  • Design the API resources, endpoints, and data shapes

  • Consider versioning, pagination, error handling patterns

Output the design:

  • Endpoints/Operations: Method, Path, Name

  • Request Schema: input validation rules

  • Response Schema: Success/Error shapes

  • Examples: JSON/Text payloads

Output

  • API Specification (OpenAPI YAML, Proto file, or Interface code)

  • Usage Example (curl or client code)

  • Design Rationale (RESTfulness, Breaking changes avoidance)

Source Transparency

This detail page is rendered from real SKILL.md content. Trust labels are metadata-based hints, not a safety guarantee.

Related Skills

Related by shared tags or category signals.

Coding

code-plan

No summary provided by upstream source.

Repository SourceNeeds Review
-16
sirn
Coding

code-explain

No summary provided by upstream source.

Repository SourceNeeds Review
-16
sirn
Coding

code-config-ci

No summary provided by upstream source.

Repository SourceNeeds Review
-16
sirn