skills.rest
ACubero
ACuberoCOMMUNITY
Explore all skills by this author →
Website𝕏@acuberoaGitHub

api-design

Design RESTful and GraphQL APIs with OpenAPI specifications and authentication guidance.

Updated Feb 25, 2026
Search Tags:#authentication#restful#api design#openapi#graphql#api versioning
One-click install
npx skills add https://github.com/ACubero/IA_AGENT_esqueleto_proyectos_python_antigravity --skill api-design-acubero
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/ACubero/IA_AGENT_esqueleto_proyectos_python_antigravity/tree/main/.agent/skills/api_design
Command: npx skills add https://github.com/ACubero/IA_AGENT_esqueleto_proyectos_python_antigravity --skill api-design-acubero

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill streamlines the process of designing robust, scalable, and professional APIs, ensuring consistency and adherence to best practices.

Core Features & Use Cases

  • RESTful Endpoint Design: Follows conventions for collections, resources, and actions.
  • OpenAPI Specification: Generates and interprets OpenAPI (Swagger) definitions for clear API documentation and contract.
  • Authentication & Versioning: Implements standard methods for securing APIs and managing changes.
  • Use Case: Design a new user management API, defining all endpoints, request/response schemas, and authentication mechanisms using OpenAPI.

Quick Start

Design a RESTful API for managing products, including endpoints for listing, creating, and retrieving products, and generate an OpenAPI v3 specification.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I design a RESTful API with proper endpoint conventions and HTTP methods?▼

To design a RESTful API, structure endpoints around collections and resources, map actions to standard HTTP methods, and define consistent response structures to ensure professional, scalable API architecture.

How do I generate an OpenAPI specification for my API documentation?▼

Generating an OpenAPI specification involves defining your endpoints, request/response schemas, and authentication mechanisms to create a clear, standardized contract for your API documentation and integration.

What are the best practices for API versioning and authentication using JWT?▼

API versioning and authentication best practices involve implementing standard strategies for managing API changes and securing endpoints using methods like JWT and API Keys to control access.

Does this API design guidance cover both REST and GraphQL endpoint structures?▼

Yes, this API design guidance covers both REST and GraphQL architectures, providing expert direction on endpoint conventions, response structures, and best practices for professional API development.

What HTTP status codes should I use for my API responses?▼

API responses should use standard HTTP status codes to accurately reflect request outcomes, adhering to a best practices checklist that ensures clear communication of success and error states.

How do I structure a new user management API from scratch?▼

Structuring a new user management API requires defining all necessary endpoints, request and response schemas, and authentication mechanisms, typically documented using an OpenAPI v3 specification.

Related Skills

Explore More Software Engineering Skills→
ruskibeatsruskibeats

t1d-api-ingestion-scout

Trace API endpoints to backend data ingestion logic in T1D Companion.

Community
Intermediate
snowdamizsnowdamiz

mesh-http

Build HTTP servers with routing, middleware, and WebSocket support.

Community
Intermediate
dinoudondinoudon

api-documentation

Generates API references and SDK scaffolds from OpenAPI specifications.

Community
Advanced
aexol-studioaexol-studio
27

axolotl-schema

Generate type-safe GraphQL models and resolver boilerplates from a schema.

Official
Intermediate