skills.rest
Axel-DaMage
Axel-DaMageCOMMUNITY
Explore all skills by this author →
GitHub

api-designer

Design REST and GraphQL APIs with OpenAPI 3.1 specifications.

2|Updated Jun 29, 2026
Search Tags:#api design#openapi#api documentation#api versioning#api architecture
One-click install
npx skills add https://github.com/Axel-DaMage/opencode-config --skill api-designer-axel-damage
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/Axel-DaMage/opencode-config/tree/main/skills/api-designer
Command: npx skills add https://github.com/Axel-DaMage/opencode-config --skill api-designer-axel-damage

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires openapi-generator, stoplight-prism, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill streamlines the process of designing, documenting, and maintaining REST and GraphQL APIs, ensuring consistency and compliance with OpenAPI 3.1 standards.

Core Features & Use Cases

  • API Design: Facilitates the creation of OpenAPI 3.1 specifications for REST and GraphQL APIs.
  • Documentation: Generates comprehensive API documentation directly from the specification.
  • Versioning: Supports API versioning and deprecation strategies for long-term maintainability.
  • Use Case: Ideal for architects and developers involved in designing and maintaining complex API ecosystems.

Quick Start

Design an API with the 'api-designer' skill. Use the 'generate-api-spec' command to start the API design process and follow the prompts to complete the specification.

Frequently Asked Questions about api-designer

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

FAQPage Schema
How do I generate OpenAPI 3.1 specifications for REST and GraphQL APIs?▼

To generate OpenAPI 3.1 specifications for REST and GraphQL APIs, use the 'generate-api-spec' command to initiate the design process and follow the prompts to complete the specification.

What is the best way to handle API versioning and deprecation strategies?▼

Handling API versioning and deprecation strategies requires a structured approach to maintain long-term API ecosystems, which can be automated using OpenAPI 3.1 specifications.

Can I use OpenAPI generator and API mock server tools for API documentation?▼

Yes, you can use OpenAPI generator and API mock server tools to generate comprehensive API documentation directly from your OpenAPI 3.1 specification.

Does this API architecture approach support both REST and GraphQL resource modeling?▼

Yes, this API architecture approach supports both REST and GraphQL resource modeling by facilitating the creation of OpenAPI 3.1 specifications.

Do I need openapi-generator and stoplight-prism to design complex API ecosystems?▼

Yes, designing and maintaining complex API ecosystems with this tool requires OpenAPI generator and API mock server tools like stoplight-prism for execution.

Related Skills

Explore More Software Engineering Skills→
miles990miles990
20

api-tools

Test and mock REST APIs using cURL, Postman, Newman, and OpenAPI.

Community
Intermediate
AI-Foundry-CoreAI-Foundry-Core
4

openapi-spec-generation

Generate OpenAPI 3.1 specifications from code and design artifacts.

Official
Advanced
VXerysVXerys

api-designer

Design REST and GraphQL APIs with OpenAPI 3.1 specifications.

Community
Advanced
thesaifalitaithesaifalitai
8

api-designer

Design REST and GraphQL API architectures and generate OpenAPI 3.1 specifications.

Community
Advanced