Will it help with error response consistency?

Yes, the skill enforces standardized response envelopes and the use of correct HTTP status codes to ensure developers have a predictable experience when errors occur.

Can it generate full OpenAPI specifications?

Absolutely. This skill is optimized to output structured documentation, including field descriptions, examples, and status codes suitable for Swagger and OpenAPI.

How does it handle API versioning?

It follows industry standards by recommending URL-based versioning (e.g., /v1/resource) to ensure that breaking changes can be managed without disrupting users.

Does this skill support both REST and GraphQL?

Yes, while it emphasizes RESTful conventions for resource paths, it is fully capable of designing schemas and defining route structures for GraphQL architectures.

API Designer

Name: API Designer
Author: k1lgor

byk1lgor

0•

API 개발

Designs industry-standard REST and GraphQL APIs with robust schemas, standardized documentation, and consistent architectural patterns.

The API Designer skill enables AI agents to architect clean, scalable, and intuitive backend interfaces by enforcing strict RESTful conventions and data contracts. It automates the creation of resource-based paths, the selection of appropriate HTTP verbs, and the generation of comprehensive OpenAPI/Swagger specifications. By providing guidance on versioning, pagination, and standardized error handling, this skill ensures that your API remains maintainable, developer-friendly, and aligned with modern industry best practices.

주요 기능

01Automated OpenAPI/Swagger specification generation

02Strict JSON Schema definition and input validation

03Standardized response envelopes and error handling

04Best practice guidance for API versioning and pagination

05Enforcement of RESTful conventions and HTTP verb usage

060 GitHub stars

사용 사례

01Defining complex JSON schemas for data validation and consistency

02Standardizing and documenting legacy API endpoints into an OpenAPI spec

03Architecting a new RESTful backend service for a web application

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add k1lgor/virtual-company 10-api-designer

For use in Claude.ai and ChatGPT

Download Skill