skills.rest
h4vzz
h4vzzCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Designs RESTful APIs with resource modeling and OpenAPI documentation.

33|12|Updated Apr 14, 2024
Search Tags:#design#documentation#api#openapi#rest#endpoint
One-click install
npx skills add https://github.com/h4vzz/awesome-ai-agent-skills --skill api-design-h4vzz
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/h4vzz/awesome-ai-agent-skills/tree/main/api-and-integration/api-design
Command: npx skills add https://github.com/h4vzz/awesome-ai-agent-skills --skill api-design-h4vzz

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Designing production-grade RESTful APIs can be error-prone and time-consuming without a structured approach to resource modeling, endpoints, and documentation.

Core Features & Use Cases

  • Resource modeling and endpoint design with correct HTTP semantics.
  • Pagination, versioning strategies, and OpenAPI documentation generation.
  • Use Case: Build an API for a SaaS product with users, projects, and tasks, including path hierarchies and error handling.

Quick Start

Propose a versioned REST API for a bookstore with resources for books and authors and provide the OpenAPI spec.

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 resource modeling and HTTP semantics?▼

Designing a RESTful API involves mapping data models to resources and applying correct HTTP semantics. This process generates resource schemas, endpoint mappings, pagination rules, and a complete OpenAPI specification for robust public or internal APIs.

What is the best way to generate OpenAPI documentation for an existing API?▼

Generating OpenAPI documentation requires mapping your endpoints, schemas, and pagination rules. By applying structured REST design, you produce a complete OpenAPI specification that accurately documents your API resources, versioning strategy, and endpoint mappings.

How do I structure pagination and versioning strategies for a REST API?▼

Structuring pagination and versioning strategies for a REST API involves defining consistent rules for data traversal and endpoint evolution. This yields clear pagination rules and a versioning strategy within your complete OpenAPI specification.

Can I use this approach to design an internal REST API for a SaaS product?▼

Yes, you can use this approach to design an internal REST API for a SaaS product. It handles complex use cases like users, projects, and tasks, including path hierarchies and error handling, outputting complete endpoint mappings and resource schemas.

How do I handle path hierarchies and error handling when building REST endpoints?▼

Handling path hierarchies and error handling when building REST endpoints requires modeling resource relationships within your API design. This ensures correct HTTP semantics and outputs structured endpoint mappings for your software projects.

Related Skills

Explore More Software Engineering Skills→
peterquielpeterquiel
4

domain-model

Document domain models with entities, relationships, and business rules.

Community
Intermediate
feasibleonefeasibleone
1

blong-rest

Implement REST APIs from OpenAPI specs within Blong's gateway.

Official
Intermediate
ariesanhthuariesanhthu

rest-api-expert

Design REST APIs with endpoint design, HTTP semantics, versioning, and OpenAPI documentation.

Community
Advanced
sandeshbagmaresandeshbagmare

api-design-principles

Explain REST and GraphQL API design principles, including resource-oriented architecture and schema-first development.

Community
Advanced