Verificação da Completude da Documentação da API
INFO
Visão Geral
Verificação da Completude da Documentação da API na sua documentação de API atual e gerar um relatório de revisão detalhado. Com base neste relatório, pode refinar e melhorar a sua documentação — tornando a colaboração mais fluida, a documentação mais fácil de ler e todas as funcionalidades de IA mais eficazes graças a especificações de endpoint mais precisas.O Que É Verificado
Verificação da Completude da Documentação da API, é útil rever se as descrições e definições na documentação de API atual estão completas. A verificação analisa os seguintes aspetos:1. Definições Básicas
| Elemento | Finalidade |
|---|---|
| Método do Pedido | Define o método HTTP (GET, POST, PUT, DELETE) para determinar a semântica do pedido, a idempotência e a estrutura dos parâmetros |
| Caminho do Pedido | O caminho completo do URL (excluindo o URL base) para identificar de forma única 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 os leitores e a IA a compreenderem a lógica de negócio |
2. Descrições dos Parâmetros
| Elemento | Finalidade |
|---|---|
| Nome do Parâmetro | Garante que a estrutura dos parâmetros está completa, que a nomenclatura é consistente e que cada parâmetro está na localização correta (Params, Body, Headers, Cookies) |
| Exemplo | Fornece valores de entrada de exemplo válidos para ajudar a compreender valores típicos, formatos, tipos de dados e significado de negócio |
| Descrição | Explica o significado, a finalidade e os cenários de negócio do parâmetro |
3. Restrições dos Parâmetros
| Restrição | Finalidade |
|---|---|
| Obrigatório/Anulável | Indica se um parâmetro é obrigatório e se são permitidos valores nulos |
| Enums/Const | Lista possíveis valores de enumeração ou constantes e os 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 dos campos, códigos de estado HTTP e códigos de erro |
Verificação da Completude da Documentação da API
Verificação da Completude da Documentação da API no canto superior direito de uma página de documentação de endpoint. Clique nela para iniciar a verificação.
Modified at 2026-06-09 08:54:45