skills.rest
bradtaylorsf
bradtaylorsfCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

api-documentation

Document RESTful and GraphQL APIs with endpoint, parameter, and error standards.

8|2|Updated Jan 15, 2026
Search Tags:#documentation#api#rest#graphql#sdk#standards
One-click install
npx skills add https://github.com/bradtaylorsf/alphaagent-team --skill api-documentation-bradtaylorsf
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-documentation
Source: https://github.com/bradtaylorsf/alphaagent-team/tree/main/plugins/aai-docs/skills/api-documentation
Command: npx skills add https://github.com/bradtaylorsf/alphaagent-team --skill api-documentation-bradtaylorsf

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides comprehensive standards and patterns for documenting both REST and GraphQL APIs, ensuring clarity, consistency, and ease of use for developers.

Core Features & Use Cases

  • REST API Standards: Defines formats for endpoints, parameters, request/response bodies, authentication, pagination, and error handling.
  • GraphQL Schema Standards: Outlines best practices for documenting types, queries, and mutations with examples.
  • SDK Examples: Includes code snippets for common languages (JavaScript, Python) and cURL for easy integration.
  • Use Case: A team is building a new microservice and needs to define clear API documentation. This Skill provides templates and guidelines to ensure all endpoints are documented consistently, making it easier for consumers to understand and integrate with the API.

Quick Start

Use the api-documentation skill to generate a template for documenting a new REST API endpoint.

Frequently Asked Questions about api-documentation

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

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

To standardize API documentation, establish formats for endpoint definitions, parameter specifications, request and response structures, authentication, pagination, and error handling across both REST and GraphQL APIs.

What is the best way to document GraphQL schema standards and mutations?▼

Documenting GraphQL schema standards involves outlining best practices for types, queries, and mutations, ensuring you include clear examples for each to help consumers understand and integrate with the API.

How do I write SDK integration examples for API documentation?▼

Write SDK integration examples by including code snippets for common languages like JavaScript and Python, alongside cURL commands, to provide clear integration patterns for developers consuming your API.

Can I use these standards to document authentication and pagination for a new microservice?▼

Yes, you can use these standards to document authentication and pagination for a new microservice by applying the provided templates and guidelines to ensure all endpoints are documented consistently.

What should I include in REST API error handling protocols?▼

REST API error handling protocols should include standardized definitions for error responses, ensuring clarity and consistency so developers can properly handle failures when integrating with the API.

Related Skills

Explore More Software Engineering Skills→
hieutrtrhieutrtr
8

api-design-patterns

Design FastAPI API contracts with Pydantic v2 schemas and pagination.

Community
Basic
JEO-tech-aiJEO-tech-ai
8

api-documentation

Generate OpenAPI/Swagger-compatible API documentation from definitions, schemas, and annotations.

Community
Advanced
bobmatnycbobmatnyc
146

Requesting Code Review

Dispatch a code-reviewer subagent to review changes against plans and requirements.

Community
Basic
jhlee0409jhlee0409
4

openapi-parser

Parse OpenAPI 3.x and Swagger 2.0 specs into structured endpoint catalogs.

Community
Advanced