skills.rest
automacoescomerciaisintegradas
automacoescomerciaisintegradasCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

api-designer

Design RESTful and GraphQL APIs with consistent architecture and documentation.

Updated Sep 1, 2025
Search Tags:#architecture#versioning#documentation#api#openapi#rest#graphql
One-click install
npx skills add https://github.com/automacoescomerciaisintegradas/PAGIA --skill api-designer-automacoescomerciaisintegradas
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/automacoescomerciaisintegradas/PAGIA/tree/main/.pagia/skills/api-designer
Command: npx skills add https://github.com/automacoescomerciaisintegradas/PAGIA --skill api-designer-automacoescomerciaisintegradas

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps teams design robust RESTful and GraphQL APIs with clear contracts, reducing miscommunication and rework by establishing consistent design principles and documentation practices.

Core Features & Use Cases

  • Design RESTful endpoints with consistent naming, versioning, and clear contracts.
  • Define GraphQL schemas and integration guidelines for scalable data fetching.
  • Produce OpenAPI/Swagger documentation and apply best practices for security, validation, and error handling.

Quick Start

Describe your API design goal by outlining resources, endpoints, and required security, and the skill will generate a complete API design and OpenAPI/GraphQL documentation.

Frequently Asked Questions about api-designer

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

FAQPage Schema
How do I design RESTful APIs with consistent naming and versioning?▼

To design RESTful APIs with consistent naming and versioning, define your resources, endpoints, and security requirements to generate a complete API design with predictable structures and clear contracts.

What is the best way to generate OpenAPI documentation for my endpoints?▼

The best way to generate OpenAPI documentation is to outline your API resources and security requirements, which produces complete OpenAPI/Swagger documentation alongside the endpoint design.

How does GraphQL schema design handle scalable data fetching?▼

GraphQL schema design handles scalable data fetching by defining schemas and integration guidelines that establish clear contracts and consistent data structures for fetching operations.

Can I apply security best practices and input validation when building new APIs?▼

Yes, you can apply security best practices and input validation when building new APIs, ensuring proper authentication, rate limiting, caching, and error handling are implemented consistently.

What should I include when reviewing existing API designs for best practices?▼

When reviewing existing API designs, check for consistent architecture, predictable pagination, rate limiting, authentication, input validation, and complete OpenAPI or GraphQL documentation.

Does this approach work for both REST and GraphQL API architectures?▼

Yes, this approach works for both REST and GraphQL API architectures by applying consistent design principles, clear contracts, and documentation practices to reduce miscommunication and rework.

Related Skills

Explore More Software Engineering Skills→
HechaoYannetHechaoYannet

create-architecture

Generate a master architecture document from GDDs, ADRs, and governance constraints.

Community
Advanced
btabaskabtabaska
1

API Contract Test

Generate contract tests validating API endpoints against OpenAPI and TypeScript types.

Community
Intermediate
HKUDSHKUDS
46.8k

cli-anything-wiremock

Manage WireMock server stubs, requests, and scenarios via command-line tools.

Official
Intermediate
Adelie-SquadAdelie-Squad
17

api-developer

Design API contracts and generate OpenAPI 3.0 documentation.

Official
Advanced