skills.rest
SPeeDoA1
SPeeDoA1COMMUNITY
Explore all skills by this author →
GitHub

api-design

Design, implement, and review RESTful and GraphQL APIs with OpenAPI schemas.

6|Updated Jan 21, 2026
Search Tags:#design#documentation#GraphQL#REST#OpenAPI#APIs#contract-testing
One-click install
npx skills add https://github.com/SPeeDoA1/everything-opencode --skill api-design-speedoa1
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/SPeeDoA1/everything-opencode/tree/main/.opencode/skills/core/api-design
Command: npx skills add https://github.com/SPeeDoA1/everything-opencode --skill api-design-speedoa1

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

APIs are the backbone of modern software, but inconsistent designs and unclear contracts cause integration friction, drift between services, and maintenance overhead.

Core Features & Use Cases

  • REST API design patterns: endpoints, status codes, versioning, pagination, and error responses.
  • GraphQL schema design and resolver guidelines.
  • Use Case: When starting a new service, define a consistent REST/GraphQL interface and documentation to accelerate onboarding and reduce contract drift.

Quick Start

Provide a concise API design brief including sample endpoints, HTTP methods, and a small OpenAPI or GraphQL schema snippet to illustrate the contract.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I design consistent REST API endpoints and HTTP status codes?▼

To design REST APIs, define consistent URL structures, HTTP methods, status codes, and response formats. This ensures predictable interfaces for resource interactions and enforces basic authentication and validation practices across your service.

What's the best way to structure a GraphQL schema and resolvers?▼

Structuring a GraphQL schema requires defining types, queries, and mutations alongside clear resolver guidelines. This approach accelerates onboarding and reduces contract drift between services by enforcing a strict, typed contract.

How do I write OpenAPI documentation for a new service?▼

Write OpenAPI documentation by providing a concise API design brief with sample endpoints, HTTP methods, and a small schema snippet. This illustrates the contract clearly, enforcing URL structure and response formats for integration.

When do I need contract testing for REST and GraphQL APIs?▼

You need contract testing for REST and GraphQL APIs when integration friction or maintenance overhead arises from inconsistent designs. It validates schemas, endpoint behavior, and response formats to prevent drift between services.

Does this approach support both REST and GraphQL architecture decisions?▼

Yes, this approach supports both REST and GraphQL architecture decisions. It applies endpoint design, versioning, pagination, error responses, and basic authentication practices across both contexts for consistent implementation.

Related Skills

Explore More Software Engineering Skills→
VeradelaCruzVeradelaCruz

api-design

Define API requirements and generate OpenAPI or GraphQL schemas.

Community
Intermediate
cosmicstack-labscosmicstack-labs
364

api-testing

Validate REST and GraphQL APIs against OpenAPI schemas and contracts.

Official
Intermediate
coreindustriescoreindustries
1

api

Design, scaffold, and document RESTful and GraphQL APIs with OpenAPI schemas.

Community
Intermediate
CuriousLearnerCuriousLearner
27

mock-server

Generate and manage mock REST and GraphQL API servers for development and testing.

Community
Advanced