api-design

Design REST and GraphQL APIs with OpenAPI documentation and versioning.

40|9|Updated Jan 4, 2026
One-click install
npx skills add https://github.com/akillness/oh-my-skills --skill api-design-akillness
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/akillness/oh-my-skills/tree/main/.agent-skills/api-design
Command: npx skills add https://github.com/akillness/oh-my-skills --skill api-design-akillness

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Streamlines the design, documentation, and governance of RESTful and GraphQL APIs to ensure consistency, scalability, and maintainability across services.

Core Features & Use Cases

  • OpenAPI-first design for REST APIs
  • GraphQL schema design and tooling guidance
  • Versioning strategies and API governance
  • Documentation generation and consistency checks

Quick Start

Design a complete API specification for a new service, including REST endpoints, GraphQL schemas, and a versioning strategy.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I design and document REST and GraphQL APIs for a new backend service?

OpenAPI-first design structures REST endpoints by defining requests, responses, and schemas upfront, which this skill uses to generate consistent API specifications and enforce governance across backend services.

What is the best way to implement API versioning and governance across microservices?

GraphQL schema design structures data types and queries using a strongly typed schema, which this skill uses to provide tooling guidance and ensure scalable data modeling for backend APIs.

Can I generate API documentation and consistency checks from an OpenAPI spec?

Yes, you can generate documentation from an OpenAPI spec, as this skill performs consistency checks and documentation generation to ensure API governance and maintainability across services.

Does this skill support both REST and GraphQL data modeling guidelines?

Yes, this skill supports both REST and GraphQL data modeling guidelines, applying versioning strategies, OpenAPI documentation, and schema design to ensure robust API consistency across backend services.