skills.rest
Danhvb
DanhvbCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

API Documentation

Document RESTful API contracts with endpoints, parameters, and responses.

Updated Feb 9, 2026
Search Tags:#documentation#api#integration#openapi#backend#rest#contracts
One-click install
npx skills add https://github.com/Danhvb/my-ba-skills --skill api-documentation-danhvb
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: API Documentation
Source: https://github.com/Danhvb/my-ba-skills/tree/main/multi-agent-ba/.agent/skills/senior-ba/api-documentation
Command: npx skills add https://github.com/Danhvb/my-ba-skills --skill api-documentation-danhvb

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Document RESTful APIs and integration requirements for developers and external partners to understand how to use services effectively.

Core Features & Use Cases

  • Define API contracts and integration points for internal and external systems.
  • Generate OpenAPI-like documentation entries for endpoints, methods, parameters, responses.
  • Use Case: A BA documents a new user management API to onboard partners.

Quick Start

Create an API documentation entry for GET /api/v1/users/{userId} including summary, parameters, responses.

Frequently Asked Questions about API Documentation

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

FAQPage Schema
How do I document RESTful API contracts for external partner onboarding?▼

Document RESTful API contracts by specifying endpoint summaries, request and response schemas, parameters, headers, payloads, status codes, and business rules to support developers and QA teams.

What is the best way to generate OpenAPI-style documentation for backend integration points?▼

Generate OpenAPI-style documentation by defining API contracts and integration points for internal and external systems, detailing endpoint methods, parameters, and responses for reliable cross-system communication.

How do I write API documentation for a GET endpoint with path parameters?▼

Write API documentation for a GET endpoint by creating an entry that includes the endpoint summary, path parameters, response schemas, and applicable status codes to clarify usage for developers.

Does this approach support documenting error handling and business rules for REST APIs?▼

Yes, documenting REST APIs includes specifying error handling, status codes, and business rules alongside endpoint summaries and payloads to ensure developers understand integration requirements.

When do I need to define API contracts for cross-system communication?▼

Define API contracts when designing new endpoints, updating existing APIs, or onboarding external partners to enable reliable, cross-system communication through clear parameters and payloads.

Can I use this to document payloads and response schemas for QA teams?▼

Yes, API documentation specifies request and response schemas, payloads, and status codes specifically to support QA teams and developers in validating integration requirements.

Related Skills

Explore More Software Engineering Skills→
bradtaylorsfbradtaylorsf
8

api-documentation

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

Community
Intermediate
HouseGarofaloHouseGarofalo
3

openapi-swagger

Design, document, and generate APIs from OpenAPI and Swagger specifications.

Official
Advanced
heidsoftheidsoft
57

api-integration-testing

Automate API integration testing for requests, responses, and authentication.

Community
Advanced
AstyanMAstyanM
1

api-docs

Generate OpenAPI, Markdown, or Postman documentation from source code.

Community
Advanced