Receber por email
← Voltar para o catálogo

api-documentation-writer

Generate comprehensive API documentation including endpoint descriptions, request/response examples, authentication guides, error codes, and SDKs. Creates OpenAPI/Swagger specs, REST API docs, and developer-friendly reference materials. Use when users need to document APIs, create technical references, or write developer documentation.

2estrelas
Atualizado há 4 meses

Ver no GitHub ↗

Como adicionar

/plugin marketplace add bg-szy/TOP-SKILLS

O comando exato pode variar conforme o repositório. Confira o README no GitHub.

Para o autor da skill

Cole no README do seu repo

Mostra que sua skill está catalogada na Skillteca, gera backlink e tráfego rastreável.

[![Skillteca](https://www.skillteca.com.br/api/badge/api-documentation-writer/svg)](https://www.skillteca.com.br/skills/api-documentation-writer)

Alerta por categoria

Receba novas skills de Escrita e Conteúdo toda segunda

1 email curto, só com as skills novas de Escrita e Conteúdo. 4 minutos de leitura, sem spam, cancela com 1 clique.

Você confirma o email no primeiro envio. Sem spam. Cancela com 1 clique.

Ler descrição completa

API Documentation Writer

Create comprehensive, developer-friendly API documentation.

Instructions

When a user needs API documentation:

  1. Gather API Information:
  2. API type (REST, GraphQL, WebSocket, gRPC)?
  3. Authentication method (API key, OAuth, JWT)?
  4. Base URL and versioning strategy?
  5. Available endpoints and their purposes?
  6. Request/response formats?
  7. Rate limiting or usage restrictions?
  1. Generate Complete Documentation Structure:

**Overview Sect

[Description truncada. Veja o README completo no GitHub.]

Compartilhar X LinkedIn