apidocs

Generate OpenAPI/Swagger specifications and API documentation from code or contracts.

26|8|Updated Mar 19, 2026
One-click install
npx skills add https://github.com/arbazkhan971/godmode --skill apidocs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: apidocs
Source: https://github.com/arbazkhan971/godmode/tree/main/skills/apidocs
Command: npx skills add https://github.com/arbazkhan971/godmode --skill apidocs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

API documentation and OpenAPI/Swagger spec maintenance can be tedious and error-prone; this skill automates contract-first or code-first docs, syncing specs with code, generating interactive docs, and enabling teams to publish accurate API references.

Core Features & Use Cases

  • Contract-first OpenAPI generation: Create complete OpenAPI specs from business requirements before implementation.
  • Code-first doc generation: Integrate with frameworks to auto-generate docs from code.
  • Interactive docs & publishing: Deploy Redoc/Swagger UI, manage versions, and CI validation to ensure docs stay in sync with APIs.

Quick Start

Generate a basic OpenAPI spec for a new Users API and start an interactive docs page.

Frequently Asked Questions about apidocs

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

FAQPage Schema
How do I generate OpenAPI specifications from existing code?

Generate OpenAPI specifications from existing code by integrating this skill with your framework to auto-extract API routes and schemas, syncing documentation directly with your codebase. It supports Node, Python, Java, and Go stacks for code-first workflows.

What is contract-first API documentation and when should I use it?

Contract-first API documentation defines your OpenAPI specification from business requirements before writing any code. Use it for API-first projects and microservices to establish a strict agreement between client and server before implementation begins.

How do I keep Swagger documentation in sync with my API during CI?

Keep Swagger documentation in sync with your API by running CI validation checks against your OpenAPI specs. This automated validation detects mismatches between your deployed API endpoints and your published documentation during the build process.

Does the apidocs skill support DRY practices for shared OpenAPI components?

The apidocs skill supports DRY practices by using the $ref keyword to reference shared OpenAPI components like schemas and parameters. This prevents duplication and maintains consistency across multiple microservice specifications.

Can I deploy interactive API docs using Redoc or Swagger UI?

You can deploy interactive API documentation using Redoc or Swagger UI. The skill manages versioning and publishing of these interactive docs, allowing teams to explore endpoints, schemas, and request examples directly from a web interface.

What is the best way to maintain API documentation for microservices across different stacks?

The best way to maintain API documentation for microservices across different stacks is to automate OpenAPI spec generation and enforce CI validation. This ensures consistent documentation across Node, Python, Java, and Go without manual updates.