api-documentation

Generates API references and SDK scaffolds from OpenAPI specifications.

Updated Jun 5, 2026
One-click install
npx skills add https://github.com/dinoudon/sdlc-skills --skill api-documentation-dinoudon
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-documentation
Source: https://github.com/dinoudon/sdlc-skills/tree/main/full/api-documentation
Command: npx skills add https://github.com/dinoudon/sdlc-skills --skill api-documentation-dinoudon

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

API documentation, SDK generation, and contract testing are often labor-intensive and error-prone; this skill unifies framework, tooling, and best practices to automate and maintain openapi-driven documentation workflows.

Core Features & Use Cases

  • OpenAPI 3.1 spec authoring and validation, with automatic documentation generation and SDK scaffolding.
  • Docs-as-code workflow and contract testing integration to keep docs in sync with implementation.
  • Interactive reference portals and API catalogs for developers.

Quick Start

Use this skill to generate an OpenAPI-based API reference and SDK scaffolds from your existing API specification.

Frequently Asked Questions about api-documentation

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

FAQPage Schema
How do I automate API documentation generation from OpenAPI specifications?

Automate API documentation generation from OpenAPI specifications by validating OpenAPI 3.1 specs and applying docs-as-code workflows to publish accurate references and developer portals at scale.

Can I generate client SDKs automatically from an OpenAPI 3.1 spec?

Yes, generate client SDKs automatically from an OpenAPI 3.1 spec by using code generation pipelines to scaffold SDKs and maintain framework consistency across REST, GraphQL, and async APIs.

What is docs-as-code workflow for API documentation?

Docs-as-code workflow for API documentation integrates contract testing and linting to keep API docs in sync with implementation, enabling teams to author, version, and validate references directly from OpenAPI specifications.

Does this approach support contract testing for REST and GraphQL APIs?

Yes, contract testing supports REST, GraphQL, and async APIs by validating OpenAPI specifications to ensure published API documentation and client SDKs remain accurately synced with implementation behavior.

What is the best way to maintain interactive developer portals at scale?

Maintain interactive developer portals at scale by automating reference generation and API catalogs from OpenAPI specifications, using integrated linting and versioning to keep documentation accurate across code generation pipelines.

Do I need an existing OpenAPI specification to start generating SDKs and documentation?

Yes, you need an existing OpenAPI specification to start generating SDKs and documentation, as the automation validates OpenAPI 3.1 specs to scaffold client SDKs and publish interactive reference portals.