Settings and Permissions (configurações e permissionamento)

Na aba Settings and Permissions, você pode:

Habilitar o registro de Apps e permitir que a API seja exibida no Catálogo.
Configurar a API para permitir que os desenvolvedores façam chamadas diretamente da documentação (tryout).
Definir os papéis (roles) para controle de acessos.
Escolher o ambiente para tryout.

aba Settings and Permissions

Esta configuração está disponível apenas para APIs importadas automaticamente com a conexão.

Enable Apps Registration indisponível para APIs HTTP

Se você está configurando uma API do tipo HTTP, o botão Enable Apps Registration estará desabilitado devido a limitações da versão atual do Gateway da AWS. Por isso, não é possível gerar credenciais ou criar Apps para esse tipo de API no Developer Portal.

Veja como:

Chegar na tela API Settings.
Permitir o registro de Apps para a API.
Permitir a exibição da API no Catálogo.
Configurar os papéis (Roles).
Escolher ambiente para tryout.

Acessando a aba Settings and Permissions

Siga estes passos para acessar a aba Settings and Permissions:

Acesse a página API DOCS, clicando no menu lateral esquerdo ou no card na tela inicial do Developer Portal.
Localize a API que deseja testar.
Se necessário, utilize a ferramenta de busca.

Na coluna ACTIONS da lista de APIs, clique em da API desejada.

A coluna AVAILABILITY indica se:

a API está disponível para exibição no catalogo e para criação de apps;
a API não está disponível para exibição no catálogo ou (ou exclusivo) para criação de apps.
a API não está disponível para exibição no catálogo e (conjunção) para criação de apps.

Permitir o registro de Apps

Para permitir que os desenvolvedores registrem suas aplicações no Developer Portal, basta selecionar a opção Enable Apps Registration.

Mantenha o botão Enable Apps Registration desabilitado se quiser bloquear o registro de Apps.

localização do toggle para habilitar o registro de Apps

Esta opção está disponível apenas para APIs de conexões nativas.

Permitir a exibição da API no Catálogo

Para permitir que a API seja exibida no Catálogo, basta selecionar a opção Enable in Portal Catalog.

Se preferir que a API não seja exibida no Catálogo, mantenha o botão Enable in Portal Catalog desabilitado.

localização do toggle para habilitar a exibição da API no Catálogo

Papéis (roles)

Você pode definir um ou mais papéis que podem ter acesso à documentação da API listada em API Docs.

Siga estes passos para editar as permissões de roles:

Acesse a página API Docs, clicando no menu lateral esquerdo ou no card na página inicial.
Encontre a API desejada e clique no ícone , na coluna ACTIONS.
Clique na aba SETTINGS & PERMISSIONS.
No campo ROLES, selecione um ou mais papéis.
Para ver a documentação da API, será necessário que o usuário tenha um desses papéis.
Um usuário que tiver um papel que não está listado aqui, não poderá acessar a API.

tela api docs update com destaque para aba settings and permissions e para o campo roles

Selecione ambiente para tryout

Com o tryout, você pode fazer chamadas para a API diretamente da documentação. Veja como utilizar o tryout.

Para definir o ambiente para o tryout:

Acesse a página API Docs, clicando no menu lateral esquerdo ou no card na página inicial.
Encontre a API desejada e clique no ícone , na coluna ACTIONS.
Clique na aba SETTINGS & PERMISSIONS.
Clique no botão SELECT TRYOUT ENVIRONMENTS.
Selecione um ou mais ambientes.
Se desejar, você pode definir um ambiente padrão. Basta selecionar a opção na coluna DEFAULT.

Os ambientes disponíveis para tryout são nomeados de maneira padronizada, independentemente do provedor, com base nas especificações técnicas do contrato da API:

Para OpenAPI 3.x: as informações são obtidas dos campos servers.url (endereço) e servers.description (nome do ambiente).
Para Swagger 2.0: a URL é formada pela combinação dos campos scheme, host e basePath.

Se o contrato não apresentar uma descrição explícita para o ambiente, o sistema utiliza o host da URL como identificador ou procura automaticamente por palavras-chave (como prod, dev ou test) para nomear o ambiente.

Thanks for your feedback!

EDIT

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