Can I use it to document internal JavaScript or Python functions?

Absolutely. The skill can scan source code to identify exported functions, parameters, and types to create detailed method-level documentation.

Does it handle complex data structures in API responses?

Yes, it creates structured tables and schemas for request bodies and response payloads to ensure all data fields are clearly explained.

Does this skill support OpenAPI and Swagger formats?

Yes, it is designed to automatically detect and parse openapi.yaml, openapi.json, swagger.yaml, and swagger.json files to generate references.

What kind of code examples does it generate?

It provides runnable examples in universal formats like curl, as well as language-specific snippets for JavaScript and Python.

API Reference Documentation

Name: API Reference Documentation
Author: darylldoyle

bydarylldoyle

0•

API 开发

Generates professional API documentation, SDK guides, and technical references from source code and specifications.

The docs-api skill empowers Claude to act as a specialized documentation engineer, transforming raw code and specifications into comprehensive technical guides. It supports a wide range of formats including REST API endpoints via OpenAPI/Swagger, internal function and method references, and full SDK documentation. By automating the creation of parameters tables, authentication guides, and multi-language code snippets, it ensures your technical documentation is accurate, consistent, and developer-friendly.

主要功能

01Standardized templates for authentication, error handling, and rate limiting

02Automated REST API reference generation from OpenAPI and Swagger specifications

03Multi-language code example generation including curl, JavaScript, and Python

040 GitHub stars

05Detailed documentation of functions, methods, parameters, and return types

06Deep analysis of public interfaces and type definitions for accurate SDK docs

使用场景

01Building complete SDK references including installation and configuration guides

02Generating internal library documentation for shared team components and functions

03Converting an OpenAPI/Swagger file into high-quality Markdown documentation

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add darylldoyle/docs-skills docs-api

For use in Claude.ai and ChatGPT