api-designer

Design RESTful and GraphQL APIs and generate OpenAPI 3.1 specifications.

Updated Jan 30, 2026
One-click install
npx skills add https://github.com/fulfon/lusena-dawn --skill api-designer-fulfon
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/fulfon/lusena-dawn/tree/main/.opencode/skills/api-designer
Command: npx skills add https://github.com/fulfon/lusena-dawn --skill api-designer-fulfon

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines the complex process of designing RESTful and GraphQL APIs, ensuring consistency, scalability, and developer-friendliness from the outset.

Core Features & Use Cases

  • API Architecture Planning: Define resource models, versioning strategies, and error handling standards.
  • Specification Generation: Create comprehensive OpenAPI 3.1 specifications for REST APIs.
  • Use Case: You need to design a new set of microservice APIs. Use this Skill to define the resource structure, endpoint contracts, and error codes for each API, ensuring they are consistent and well-documented.

Quick Start

Use the api-designer skill to create an OpenAPI 3.1 specification for a new user management API.

Frequently Asked Questions about api-designer

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

FAQPage Schema
How do I create an OpenAPI 3.1 specification for a new REST API?

To create an OpenAPI 3.1 specification, define your resource models, endpoint contracts, and error handling standards. This process ensures your REST API architecture is consistent, scalable, and developer-friendly from the outset.

What is the best way to plan API architecture and resource modeling for microservices?

The best way to plan API architecture is to systematically model resources, define endpoint contracts, and establish error handling standards for each microservice. This ensures consistency and scalability across your distributed services.

Can I design both RESTful and GraphQL APIs using the same approach?

Yes, you can design both RESTful and GraphQL APIs using the same approach. The process involves modeling resources, defining endpoints or schemas, and establishing versioning strategies and pagination patterns for your API architecture.

How does API versioning strategy and pagination pattern planning work?

API versioning strategy and pagination pattern planning work by defining consistent rules for resource evolution and data retrieval across your endpoints. This standardizes how clients interact with large datasets and manage structural changes over time.

How do I define consistent error handling standards and API contracts for a user management API?

To define error handling standards and API contracts for a user management API, model the specific user resources, outline the endpoint interactions, and generate a comprehensive OpenAPI 3.1 specification documenting all possible error codes.