Catalog

A página Catalog exibe a documentação das suas APIs, organizadas por produto.

Siga os passos abaixo para fazer o download de um swagger.

  1. Acesse o seu Developer Portal.
    Entre diretamente no link ou acesse o Portal Manager e clique em Portal  Appearance para obter o link.

  2. Clique em APIs  Catalog, no canto superior direito da tela.
    É necessário estar logado.

    detalhe do cabeçalho do developer portal com indicação do link para o catalog

  3. Selecione o produto desejado.
    Se necessário, utilize o campo de busca por API ou o filtro por produtos.

  4. Clique no botão DOCUMENTATION da API.
    As imagens abaixo são apenas ilustrativas. Cores, logos e outros elementos podem variar de acordo com a personalização feita em Portal > Appearance do Portal Manager.

    detalhe da tela do developer portal produto e botão documentation

  5. Na parte superior direita, selecione a revisão do documento e clique em DOWNLOAD SWAGGER.

    detalhe da tela catalog com opções de document revision e botão de download

Acessos

Para ver a documentação de uma API do catálogo é necessário:

  1. que a rota API Catalog esteja definida em pelo menos um papel;

  2. que o produto e a API estejam definidas com esse papel;

  3. que o usuário possua um papel com as características 1 e 2.

Administrador, caso um usuário não veja um produto ou API no catálogo de APIs, verifique:

Cadastrando e editando papéis (roles) para um produto

Administrador, siga estes passos para definir quais papéis podem acessar o Catálogo de APIs:

  1. No Portal Manager, clique em Products, localizado no menu lateral esquerdo ou na tela inicial.
    tela inicial com destaque para products

  2. Clique no ícone ícone de um lápis do produto que deseja editar.

  3. Em Roles, selecione os papéis que terão acesso aos produtos do catálogo de APIs.
    passo 1 do cadastro de products com roles em destaque

Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]