api-docs

Convert REST endpoint behavior into OpenAPI 3.0+ specifications.

Updated May 26, 2026
One-click install
npx skills add https://github.com/anukkrit149/anukkrit-skills --skill api-docs-anukkrit149
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-docs
Source: https://github.com/anukkrit149/anukkrit-skills/tree/main/cloud/skills/api-docs
Command: npx skills add https://github.com/anukkrit149/anukkrit-skills --skill api-docs-anukkrit149

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams avoid inconsistent, underspecified REST APIs by standardizing how endpoints, schemas, errors, and pagination are documented.

Core Features & Use Cases

  • OpenAPI 3.0+ documentation: Produces specs that clearly define paths, parameters, responses, and component schemas.
  • REST conventions enforcement: Guides consistent resource naming, correct HTTP method usage, versioning, and list pagination.
  • Error response structuring: Standardizes validation and server error payload formats for predictable client handling.
  • Use Case: When building a backend for a dashboard, it helps you document endpoints like /v1/users with consistent request parameters, response schemas, and standardized error objects.

Quick Start

Describe your REST endpoints, request/response data models, and desired versioning, and ask the Skill to draft an OpenAPI 3.0+ spec that follows the provided standards.

Frequently Asked Questions about api-docs

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

FAQPage Schema
How do I generate an OpenAPI 3.0 spec for my REST API endpoints?

To generate an OpenAPI 3.0 spec for your REST API, define your endpoint paths, request parameters, and response schemas. This standardizes your API documentation by converting endpoint behavior into a structured specification with consistent REST conventions.

What is the best way to structure error payloads for a REST API?

The best way to structure error payloads for a REST API is to use standardized response codes and structured error objects. This ensures predictable client handling by defining consistent validation and server error payload formats in your documentation.

How do I document paginated list routes in an OpenAPI specification?

To document paginated list routes in an OpenAPI specification, describe your list endpoints and apply consistent REST conventions for pagination. This defines the specific parameters and response schemas required for web clients handling paginated data.

Can I use this to standardize versioning across my backend CRUD APIs?

Yes, you can standardize versioning across your backend CRUD APIs by specifying your desired versioning approach. It enforces consistent resource naming and correct HTTP method usage for versioned APIs intended for web clients and integrations.

What do I need to provide to draft OpenAPI documentation for a web dashboard backend?

To draft OpenAPI documentation for a web dashboard backend, you need to provide descriptions of your REST endpoints, request/response data models, and desired versioning. This allows the generation of a spec defining paths, components, and structured error payloads.