Verificação de conformidade de endpoint

INFO

Consulte Introdução aos recursos de IA para ver os requisitos de configuração.

Visão geral

Você pode usar IA para realizar uma verificação de conformidade de endpoint na sua documentação de API atual com base nas diretrizes de design de API. A IA gerará um relatório abrangente para ajudar você a melhorar sua documentação de API, de modo que ela fique mais alinhada aos padrões de design — tornando-a mais profissional, consistente e fácil de ler.

O que a verificação de conformidade avalia

A IA analisa seu endpoint de acordo com vários critérios:

Critérios	Descrição
Convenções de nomenclatura	Verifica se os caminhos de endpoint, parâmetros e campos seguem padrões de nomenclatura padrão
Completude da documentação	Verifica se descrições, exemplos e restrições são fornecidos
Uso de métodos HTTP	Garante o uso adequado de GET, POST, PUT, DELETE etc.
Estrutura da resposta	Valida o formato da resposta e o tratamento de erros
Práticas de segurança	Analisa os requisitos de autenticação e autorização

Como usar a verificação de conformidade de endpoint

Você pode acessar o recurso de verificação de conformidade de endpoint no canto superior direito de qualquer página de documentação de API. Basta clicar nele para iniciar a verificação de conformidade de endpoint orientada por IA.

Depois de clicar no botão Endpoint compliance check, a IA analisará a documentação da API com base nas diretrizes de design de API. Em seguida, ela 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 de endpoint

Verificação de conformidade de endpoint

Visão geral#

O que a verificação de conformidade avalia#

Como usar a verificação de conformidade de endpoint#

Visão geral

O que a verificação de conformidade avalia

Como usar a verificação de conformidade de endpoint