Solução de problemas de configuração da especificação da API

URL de servidor ausente ou incorreta na especificação da OpenAPI

Quando ocorre: O botão Experimente! não aparece, ou os consumidores da API não sabem qual URL base usar para suas solicitações.

Por que isso acontece: A servers seção está ausente na especificação da OpenAPI ou contém uma URL incorreta. Sem ele, os usuários da API não conseguem determinar para onde enviar solicitações e as ferramentas de documentação não conseguem preencher o recurso Experimente!

Como consertar:

1. Adicione uma seção correta servers à sua especificação:

   servers:
     - url: https://api.yourdomain.com
       description: Production

2. Para APIs específicas de região, defina múltiplas entradas de servidor:

   servers:
     - url: https://api.yourdomain.com
       description: Global
     - url: https://api.us.yourdomain.com
       description: US region

3. Certifique-se de que todos os clientes da API (por exemplo, Postman, cURL) usem a URL correta do servidor ao fazer requisições.

i️ NOTA
As URLs acima são exemplos. Use a URL base real da sua API.

Corpo vazio mostrado na documentação da API

Quando ocorre: O corpo da requisição de um endpoint aparece como vazio na documentação publicada.

Por que isso acontece: O esquema OpenAPI está ausente "type": "object" em uma ou mais definições de objetos.

Como consertar: Garanta que toda definição de objeto na sua especificação OpenAPI inclua "type": "object". Esse atributo ensina ao Document360 como renderizar com precisão os parâmetros do corpo das requisições e os esquemas de resposta, facilitando para os desenvolvedores entenderem e interagirem com sua API.