Does it include authentication patterns?

Yes, it includes specific sections for documenting Bearer tokens, API keys, and the process for obtaining tokens via auth endpoints.

Is this skill restricted to PHP projects?

While it is part of a PHP Architecture Toolkit, the Markdown templates and documentation patterns are applicable to any RESTful API regardless of the backend language.

How does it handle error documentation?

It provides structured tables for HTTP status codes and specific business logic error codes, ensuring consumers understand exactly why a request failed.

Can it document complex JSON structures?

Yes, the templates support nested objects and arrays, allowing for detailed descriptions of complex request bodies and response payloads.

What output format does this skill use?

This skill generates documentation in standardized Markdown, making it easy to host on GitHub, GitLab, or static site generators like Docusaurus.

API Documentation Generator

Name: API Documentation Generator
Author: dykyi-roman

bydykyi-roman

•

API Development

Generates comprehensive, standardized REST API documentation including authentication, endpoints, and error handling for PHP projects.

The API Documentation Generator is a specialized skill designed to streamline the creation of technical documentation for RESTful services. It provides standardized Markdown templates for defining base URLs, authentication methods like Bearer tokens and API keys, and detailed endpoint schemas. By automatically identifying routes and actions, it helps developers maintain high-quality, consistent documentation featuring realistic request/response examples and exhaustive error code tables, ensuring that API consumers have a clear and accurate integration guide.

Key Features

01Comprehensive authentication documentation (Bearer and API Key)

02Rate limiting and header documentation templates

03Standardized Markdown templates for professional API references

0445 GitHub stars

05Detailed request/response field mapping with data types

06Pre-built tables for HTTP status codes and common error formats

Use Cases

01Generating initial API reference documentation for new PHP microservices

02Creating detailed integration guides with realistic JSON examples for external consumers

03Standardizing documentation layouts across multiple team-driven projects

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add dykyi-roman/awesome-claude-code api-doc-template

For use in Claude.ai and ChatGPT

Download Skill