Verificação de Completude da Documentação da API
INFO
Visão geral
Verificação de Completude da Documentação da API na sua documentação de API atual e gerar um relatório de revisão detalhado. Com base nesse relatório, você pode refinar e melhorar sua documentação — tornando a colaboração mais fluida, a documentação mais fácil de ler e todos os recursos de IA mais eficazes graças a especificações de endpoint mais precisas.O que é verificado
Verificação de Completude da Documentação da API, é útil revisar se as descrições e definições na documentação de API atual estão completas. A verificação analisa os seguintes aspectos:1. Definições básicas
| Elemento | Finalidade |
|---|---|
| Método da requisição | Define o método HTTP (GET, POST, PUT, DELETE) para determinar a semântica da requisição, idempotência e estrutura de parâmetros |
| Caminho da requisição | O caminho completo da URL (excluindo a URL base) para identificar exclusivamente o endpoint e inferir a estrutura dos parâmetros de caminho |
| Nome e descrição do endpoint | Breve explicação da finalidade do endpoint para ajudar leitores e a IA a entenderem a lógica de negócios |
2. Descrições de parâmetros
| Elemento | Finalidade |
|---|---|
| Nome do parâmetro | Garante que a estrutura dos parâmetros esteja completa, que a nomenclatura seja consistente e que cada parâmetro esteja no local correto (Params, Body, Headers, Cookies) |
| Exemplo | Fornece valores de entrada de amostra válidos para ajudar a entender valores típicos, formatos, tipos de dados e significado de negócios |
| Descrição | Explica o significado, a finalidade e os cenários de negócios do parâmetro |
3. Restrições de parâmetros
| Restrição | Finalidade |
|---|---|
| Obrigatório/Anulável | Indica se um parâmetro é obrigatório e se valores nulos são permitidos |
| Enums/Const | Lista possíveis valores de enumeração ou constantes e seus significados |
| Valores-limite | Fornece valores mínimos/máximos, limites de comprimento e outras restrições |
| Formato | Descreve formatos especiais (date-time, email, uuid, binary, int64, json-string, etc.) |
4. Resposta
| Elemento | Finalidade |
|---|---|
| Corpo da resposta | Fornece a estrutura completa para o tipo de conteúdo da resposta, explicações de campos, códigos de status HTTP e códigos de erro |
Verificação de Completude da Documentação da API
Verificação de Completude da Documentação da API no canto superior direito de uma página de documentação de endpoint. Clique nele para iniciar a verificação.
Modified at 2026-06-11 10:21:25