🔌
ChatGPT intermediate

Estratégias de documentação em api design em API Design

Prompt gerado automaticamente para Documentação em API Design em API Design

2 usos API Design

Prompt completo

"Você é um especialista em design de API e comunicação técnica. Elabore um guia passo a passo detalhado para equipes de desenvolvimento, explicando como criar e manter uma documentação de API RESTful *interativa* e *centrada no desenvolvedor*. O guia deve abordar desde a escolha de ferramentas (ex: Swagger UI, Redocly) até as melhores práticas para descrever endpoints, parâmetros, autenticação e exemplos de uso, focando em como facilitar a integração de terceiros e reduzir o tempo de 'time-to-first-call' para novos usuários da API."

Tags relacionadas

API Design Documentação em API Design gerado-automaticamente

Como usar este prompt

1

Clique no botão "Copiar" para copiar o prompt para sua área de transferência

2

Acesse sua ferramenta de IA preferida (ChatGPT, ChatGPT, Claude, etc.)

3

Cole o prompt e adapte conforme necessário para seu contexto específico