Exportar para especificação de OpenAPI

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 1 min. de leitura
  • Exporte uma REST API como uma especificação OpenAPI para importá-la para outra ferramenta de serviços web.

    Antes de Iniciar

    Função necessária: web_service_admin, rest_api_explorer ou admin

    Procedimento

    1. Navegar até Todos > Serviços web do sistema > REST > Explorador de REST API.
    2. Selecione a API que você deseja exportar.
      Por exemplo, use essas opções para selecionar a API da tabela para exportação.
      Campo Valor
      Namespace agora
      Nome da API API da tabela
      Versão da API mais recente
    3. Abaixo da lista de métodos de API, selecione o link para o formato de exportação que você deseja usar.
      OpçãoDescrição
      Exportar a especificação de OpenAPI (YAML) Formate a exportação em YAML.
      Exportar a especificação de OpenAPI (JSON) Formate a exportação em JSON.
      O navegador exibe uma janela para selecionar um local de download.
    4. Selecione o local de download e o nome do arquivo.
    5. Salve o arquivo.

    Resultado

    O sistema baixa a API no formato selecionado.

    O que Fazer Depois

    Importe a API para uma ferramenta de serviços web, como Postman ou Insomnia.