Verificação de Conformidade do Endpoint

INFO

Consulte Introdução às Funcionalidades de IA para conhecer os requisitos de configuração.

Visão Geral

Pode utilizar a IA para realizar uma verificação de conformidade do endpoint na sua documentação de API atual com base nas diretrizes de design de API. A IA irá gerar um relatório abrangente para o ajudar a melhorar a sua documentação de API, para que fique mais alinhada com as normas de design — tornando-a mais profissional, consistente e fácil de ler.

O Que a Verificação de Conformidade Avalia

A IA analisa o seu endpoint com base em vários critérios:

Critério	Descrição
Convenções de Nomenclatura	Verifica se os caminhos dos endpoints, parâmetros e campos seguem padrões de nomenclatura padrão
Completude da Documentação	Verifica se são fornecidas descrições, exemplos e restrições
Utilização de Métodos HTTP	Garante a utilização adequada de GET, POST, PUT, DELETE, etc.
Estrutura da Resposta	Valida o formato da resposta e o tratamento de erros
Práticas de Segurança	Revê os requisitos de autenticação e autorização

Utilizar a Verificação de Conformidade do Endpoint

Pode aceder à funcionalidade de verificação de conformidade do endpoint a partir do canto superior direito de qualquer página de documentação de API. Basta clicar para iniciar a verificação de conformidade do endpoint orientada por IA.

Após clicar no botão Endpoint compliance check, a IA irá analisar a documentação da API com base nas diretrizes de design de API. Em seguida, fornecerá uma pontuação para cada critério de avaliação, juntamente com explicações detalhadas e sugestões de melhoria.

Verificar Diretrizes de Design do Endpoint

Verificação de Conformidade do Endpoint

Visão Geral#

O Que a Verificação de Conformidade Avalia#

Utilizar a Verificação de Conformidade do Endpoint#

Visão Geral

O Que a Verificação de Conformidade Avalia

Utilizar a Verificação de Conformidade do Endpoint