skills.rest
r3d3y3s79
r3d3y3s79COMMUNITY
Explore all skills by this author →
GitHub

api-documentation

Generate structured API documentation with examples, authentication, and error codes.

Updated Feb 28, 2026
Search Tags:#documentation#api#rest#graphql#sdk#developer portal
One-click install
npx skills add https://github.com/r3d3y3s79/joseph-skills --skill api-documentation-r3d3y3s79
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-documentation
Source: https://github.com/r3d3y3s79/joseph-skills/tree/main/free/developer/api-documentation
Command: npx skills add https://github.com/r3d3y3s79/joseph-skills --skill api-documentation-r3d3y3s79

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps you create clear, consistent, and developer-friendly documentation for APIs, reducing support tickets and accelerating integration.

Core Features & Use Cases

  • Endpoint Documentation: Document REST APIs, GraphQL endpoints, or SDK methods.
  • Structured Output: Generates documentation with request/response examples, authentication, and error codes.
  • Use Case: You've just built a new REST API endpoint for user creation. Use this Skill to generate a comprehensive Markdown document for that endpoint, including example requests and responses, to include in your developer portal.

Quick Start

Use the api-documentation skill to document a POST request to the /users endpoint.

Frequently Asked Questions about api-documentation

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

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

Document GraphQL endpoints by generating structured technical documentation that covers schemas, queries, mutations, and authentication details. This ensures developer-friendly GraphQL API references with consistent examples.

What is the best way to document SDK methods and authentication details?▼

Document SDK methods by generating comprehensive references that include authentication requirements, request/response schemas, and error codes. This creates consistent, developer-friendly documentation that accelerates integration.

Can I use this to create documentation for a developer portal?▼

Yes, you can create developer portal content by generating structured Markdown documents for REST, GraphQL, and SDK methods. This outputs clear technical documentation with examples, reducing support tickets and accelerating integration.

Does API documentation generation include error codes and response schemas?▼

API documentation generation includes error codes and request/response schemas to ensure completeness. This provides developers with the necessary technical details to handle exceptions and validate data structures during integration.

How do I document a POST request to a specific endpoint with examples?▼

Document a POST request by generating a comprehensive Markdown document for the endpoint, including example requests and responses. This structures the API documentation with authentication details and error codes for clear integration guidance.

Related Skills

Explore More Software Engineering Skills→
VinedineVinedine
2

c4-document-system

Generates technical architecture documentation from Structurizr DSL definitions and source code repositories.

Community
Advanced
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
mariotoffiamariotoffia

setup-contract-tests

Automate contract testing setup for microservices using OpenAPI and JSON Schema.

Community
Advanced
thktthkt
11

documenting-apis

Generate Markdown API specs and OpenAPI/Swagger files from codebase analysis.

Community
Advanced