api-designer

Design REST and GraphQL API architectures with OpenAPI 3.1 contracts.

Updated Jun 16, 2026
One-click install
npx skills add https://github.com/Design-System-ET/genexus-dev-opencode --skill api-designer-design-system-et
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/Design-System-ET/genexus-dev-opencode/tree/main/skills/api-designer
Command: npx skills add https://github.com/Design-System-ET/genexus-dev-opencode --skill api-designer-design-system-et

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses the complexity of designing consistent, secure, and well-documented APIs by providing a standardized framework for resource modeling and contract specification.

Core Features & Use Cases

  • Contract-First Design: Facilitates the creation of OpenAPI 3.1 specifications before implementation.
  • Standardized Patterns: Enforces RESTful principles, RFC 7807 error handling, and pagination strategies.
  • Use Case: Use this Skill when you need to define a new microservice interface, ensuring that your URI patterns, HTTP methods, and error responses are consistent with industry best practices.

Quick Start

Use the api-designer skill to generate an OpenAPI 3.1 specification for a new user management service with RESTful endpoints.

Frequently Asked Questions about api-designer

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

FAQPage Schema
How do I design a REST API architecture that is OpenAPI 3.1 compliant?

To design a REST API architecture compliant with OpenAPI 3.1, you define resource modeling, endpoint URIs, and HTTP methods as a contract specification before implementation. This ensures standardized patterns for consistent and secure interfaces.

What is the best way to structure RFC 7807 error handling in GraphQL and REST APIs?

Structuring RFC 7807 error handling involves applying standardized problem details for HTTP API responses. This framework enforces consistent RESTful error response patterns alongside your GraphQL and REST endpoint definitions.

How do I plan API versioning and deprecation strategies for a new microservice interface?

Planning API versioning and deprecation strategies involves defining the full lifecycle of API development from initial URI planning to retirement. This provides a standardized framework for consistent microservice interface evolution.

Does this API design approach support contract-first development for both REST and GraphQL?

Yes, this API design approach supports contract-first development by facilitating the creation of OpenAPI 3.1 specifications before implementation. It covers both REST and GraphQL architectures for robust resource modeling.

How do I implement consistent pagination patterns in an OpenAPI specification?

Implementing consistent pagination patterns in an OpenAPI specification requires enforcing standardized strategies during endpoint definition. This ensures your RESTful API interfaces maintain consistent data retrieval across resources.

When do I need to create an OpenAPI specification before coding my API?

You need to create an OpenAPI specification before coding when adopting a contract-first design approach. This solves the complexity of designing consistent, secure, and well-documented APIs by standardizing resource modeling first.