api-documentation

Document RESTful and GraphQL APIs with OpenAPI specifications and interactive tools.

17|5|Updated Feb 6, 2026

Search Tags:#documentation #api #openapi #rest #graphql #swagger

Ready to run

npx skills add https://github.com/Logos-Liber/Atlas-Agent-Teams --skill api-documentation-logos-liber

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-documentation
Source: https://github.com/Logos-Liber/Atlas-Agent-Teams/tree/main/teams/documentation/skills/api-documentation
Command: npx skills add https://github.com/Logos-Liber/Atlas-Agent-Teams --skill api-documentation-logos-liber

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides comprehensive guidance on creating clear, effective, and standardized documentation for APIs, ensuring developers can easily understand and integrate with them.

Core Features & Use Cases

OpenAPI/Swagger Standards: Learn the structure and key elements of OpenAPI specifications for RESTful APIs.
Documentation Patterns: Understand best practices for documenting endpoints, responses, pagination, and GraphQL schemas.
Interactive Tools: Discover tools like Swagger UI and Redoc for generating interactive and user-friendly API documentation.
Use Case: A new backend service needs its API documented according to industry standards to facilitate external developer adoption.

Quick Start

Use the api-documentation skill to generate a clear OpenAPI 3.0 specification for a new REST API.

Frequently Asked Questions about api-documentation

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

FAQPage Schema

How do I document a REST API using OpenAPI specifications?▼

To document a REST API using OpenAPI specifications, you structure endpoints, parameters, and response schemas following the OpenAPI standard. This process generates a clear, standardized reference for external developer adoption.

What is the best way to document GraphQL schemas and endpoints?▼

Documenting GraphQL schemas involves applying specific patterns to describe types, queries, and mutations clearly. This practice provides developers with the necessary structure to understand and integrate with GraphQL services effectively.

How do I generate interactive API documentation with Swagger UI or Redoc?▼

You generate interactive API documentation with Swagger UI or Redoc by passing your OpenAPI specification into these tools. They automatically render user-friendly interfaces that allow developers to explore and test endpoints.

What pagination strategies should I use when documenting API responses?▼

When documenting API responses, clearly detail pagination strategies like offset, cursor, or page-based approaches. Explicitly documenting these patterns helps developers handle large datasets and understand response boundaries.

Can I use this approach to document SDKs alongside my API reference?▼

Yes, you can use these guidelines to document SDKs alongside your API reference. The approach covers structuring code examples and SDK documentation to ensure clarity and usability for developers integrating with your services.