api-designer

Design REST and GraphQL APIs by producing OpenAPI 3.1 specifications.

Updated Jan 9, 2026
One-click install
npx skills add https://github.com/dieu-donnee/luxtrax --skill api-designer-dieu-donnee
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/dieu-donnee/luxtrax/tree/main/.agent/skills/api-designer
Command: npx skills add https://github.com/dieu-donnee/luxtrax --skill api-designer-dieu-donnee

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill helps API teams craft robust, standards-compliant REST and GraphQL interfaces by producing precise OpenAPI specifications, ensuring consistency and scalability across services.

Core Features & Use Cases

  • Resource modeling and endpoint design for REST/GraphQL
  • OpenAPI 3.1 specification creation and lint guidance
  • Versioning, error handling, and pagination strategies for scalable APIs
  • Use Case: Design a new user service API and generate a ready-to-lint OpenAPI spec

Quick Start

Draft an OpenAPI 3.1 specification for a new resource and validate it with a linter.

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 with OpenAPI 3.1 compliance?

Design a REST API with OpenAPI 3.1 by modeling resources, defining endpoints, and establishing versioning strategies. This process enforces RESTful design principles and generates a ready-to-lint OpenAPI specification.

What is the best way to structure error responses in a GraphQL API?

Structure GraphQL API error responses using RFC 7807 standards. This strategy ensures consistent, standardized error payloads across your REST and GraphQL services.

How do I create an OpenAPI specification for resource modeling and pagination?

Create an OpenAPI specification by defining resource models and applying pagination strategies. This yields a comprehensive document ensuring scalability and consistency across your API endpoints.

Can I use OpenAPI to document both REST and GraphQL interfaces?

Yes, you produce OpenAPI specifications to document both REST and GraphQL interfaces. This ensures consistency, standards compliance, and comprehensive documentation guidance across your services.

Does this approach support versioning strategies for scalable APIs?

Yes, this approach supports versioning strategies for scalable APIs. It helps API teams craft robust interfaces by producing precise OpenAPI specifications ensuring consistency across services.