skills.rest
Pixel-Process-UG
Pixel-Process-UGOFFICIAL
Explore all skills by this author →
WebsiteGitHub

api-design

Design API endpoints with request/response schemas and OpenAPI specifications.

1|Updated Mar 15, 2026
Search Tags:#api design#openapi#rest#graphql#endpoint design#api conventions
One-click install
npx skills add https://github.com/Pixel-Process-UG/superkit-agents --skill api-design-pixel-process-ug
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/Pixel-Process-UG/superkit-agents/tree/main/templates/skills/api-design
Command: npx skills add https://github.com/Pixel-Process-UG/superkit-agents --skill api-design-pixel-process-ug

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines the process of designing API endpoints, ensuring consistency, clarity, and adherence to best practices from the outset.

Core Features & Use Cases

  • Guided Discovery: Asks targeted questions to understand resource needs, consumer requirements, and project constraints.
  • Endpoint Specification: Defines HTTP methods, request/response schemas, error handling, and authentication for each endpoint.
  • Paradigm Selection: Helps choose between REST, GraphQL, and tRPC based on project needs.
  • OpenAPI Generation: Produces a valid OpenAPI specification for the designed API.
  • Use Case: Designing a new set of RESTful endpoints for a user management system, including endpoints for creating, retrieving, updating, and deleting users, with clear request/response formats and error codes.

Quick Start

Use the api-design skill to design the API.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I design REST API endpoints with proper request and response schemas?▼

Designing REST API endpoints involves defining HTTP methods, request/response schemas, error handling, and authentication. This process is guided by targeted questions to understand resource needs and project constraints, yielding a valid OpenAPI specification.

What is the best way to choose between REST, GraphQL, and tRPC for my API?▼

Choosing between REST, GraphQL, and tRPC depends on your project needs and consumer requirements. A guided discovery process helps evaluate these factors to select the appropriate paradigm for endpoint specification and resource definition.

Can I generate an OpenAPI specification directly from my API design?▼

Generating an OpenAPI specification is a direct output of the API design process. It is produced after defining your endpoints, schemas, error handling, and authentication, ensuring consistency and adherence to best practices.

How do I handle error handling and authentication when designing an API?▼

Handling error handling and authentication during API design requires explicitly defining these elements for each endpoint. This ensures robust endpoint specification across REST, GraphQL, or tRPC paradigms.

What steps are involved in resource discovery for API endpoint design?▼

Resource discovery for API endpoint design involves answering targeted questions about resource needs, consumer requirements, and project constraints. This guided process defines operations and schemas before generating the final specification.

Related Skills

Explore More Software Engineering Skills→
shiroginshirogin
1

business-context

Capture project identity, principles, stakeholders, boundaries, and success criteria.

Community
Advanced
mahg-esmahg-es
3

api-design

Design REST and GraphQL APIs with OpenAPI 3.1 specifications.

Official
Advanced
summarybotngsummarybotng
2

QE Contract Testing

Automate API contract testing with Pact, OpenAPI, and GraphQL schema validation.

Official
Advanced
firdaus12pfirdaus12p
8

spec-init

Generate architecture, rules, schema, API, and PRD specifications from codebases.

Community
Advanced