skills.rest
maltemd
maltemdCOMMUNITY
Explore all skills by this author →
GitHub

writing-api-documentation

Generate API documentation with endpoints, authentication, schemas, and error handling.

Updated Feb 26, 2026
Search Tags:#technical writing#graphql#documentation generation#rest api#api documentation#developer docs
One-click install
npx skills add https://github.com/maltemd/hoover-content-design-system --skill writing-api-documentation-maltemd
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: writing-api-documentation
Source: https://github.com/maltemd/hoover-content-design-system/tree/main/skills/technical-documentation/writing-api-documentation
Command: npx skills add https://github.com/maltemd/hoover-content-design-system --skill writing-api-documentation-maltemd

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires pydantic, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill addresses the challenge of creating accurate, developer-friendly API documentation that is often time-consuming and prone to errors.

Core Features & Use Cases

  • Endpoint Documentation: Generates detailed documentation for REST, GraphQL, or RPC APIs, including methods, paths, parameters, and request/response schemas.
  • Authentication & Error Handling: Clearly documents authentication mechanisms and provides comprehensive error code references.
  • Executable Examples: Creates practical code examples (e.g., curl) to help developers integrate with the API quickly.
  • Use Case: A software team needs to document a new set of API endpoints for their public-facing service. This Skill can be used to generate all necessary documentation, ensuring consistency and adherence to best practices.

Quick Start

Use the writing-api-documentation skill to generate documentation for a new POST endpoint that creates a user, including request parameters, response schema, and an example.

Frequently Asked Questions about writing-api-documentation

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

FAQPage Schema
How do I generate API documentation for REST and GraphQL endpoints?▼

You can generate API documentation for REST, GraphQL, and RPC APIs by using Markdown templates and validation scripts. This process covers endpoints, authentication, parameters, request and response schemas, and error handling.

What's the best way to document API authentication and error codes?▼

Documenting API authentication and error codes is handled through built-in Markdown templates that detail authentication mechanisms and provide comprehensive error code references for developers.

Can I create executable curl examples for my developer docs?▼

Yes, you can create practical executable examples like curl commands for developer docs. This helps developers quickly understand how to integrate with your API endpoints.

Do I need Pydantic to document request and response schemas?▼

Yes, Pydantic is required as a dependency to validate data structures. It ensures the accuracy of your request and response schemas when generating comprehensive API documentation.

How do I ensure my API documentation adheres to technical writing standards?▼

You ensure API documentation adheres to technical writing standards by utilizing built-in validation scripts. These scripts automatically verify accuracy and consistency across your REST, GraphQL, or RPC API docs.

What is included when documenting an API endpoint for a public-facing service?▼

Documenting an API endpoint includes detailing the method, path, parameters, request and response schemas, authentication mechanisms, and error handling. This ensures consistency and best practices for public-facing services.

Related Skills

Explore More Software Engineering Skills→
jonnabiojonnabio
6

outlines

Generate structured text from unstructured input using Pydantic models and JSON schemas.

Community
Advanced
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
UnicornUnicorn

doc-agent

Generate README files, API references, and docstrings from source code.

Official
Intermediate
pdylanrosspdylanross
1

api-swagger-support

Generate and serve Swagger/OpenAPI documentation for Go APIs.

Community
Intermediate