Skills
.Work. You
Rest

doc-api-endpoints

Community

Generate professional API documentation.

Software Engineering#developer tools#openapi#code generation#swagger#rest api#api documentation
Authornashgao
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill automates the creation of comprehensive API documentation, ensuring clarity, consistency, and ease of use for developers.

Core Features & Use Cases

  • Endpoint Documentation: Generates detailed Markdown files for individual API endpoints, including parameters, request/response formats, and error codes.
  • OpenAPI/Swagger Specs: Creates machine-readable API specifications.
  • Code Examples: Provides ready-to-use code snippets for various languages (curl, JavaScript, Python, Go).
  • Use Case: Documenting a new REST API service to provide clear guidelines for internal and external developers, reducing integration time and support overhead.

Quick Start

Use the doc-api-endpoints skill to document the '/users/{userId}' endpoint.

Dependency Matrix

Required Modules

None required

Components

scriptsreferences

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: doc-api-endpoints
Download link: https://github.com/nashgao/mqtt-client/archive/main.zip#doc-api-endpoints

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.