Criar um esquema de segurança
O Apidog oferece uma ampla variedade de tipos de esquemas de segurança, com suporte a diversos métodos de autenticação, incluindo:1.
API Key – Autentique usando uma chave passada via cabeçalho, query ou cookie.
2.
Bearer Token – Autentique usando o cabeçalho Authorization: Bearer.
3.
JWT – Autentique com tokens no formato JSON Web Token.
4.
Basic Auth – Use um nome de usuário e senha para autenticação básica.
5.
Digest Auth – Mais seguro do que a autenticação básica.
6.
OAuth 2.0 – Um padrão de autorização amplamente adotado, com suporte a vários tipos de concessão.
7.
OAuth 1.0 – Uma versão anterior do OAuth com um mecanismo de assinatura diferente.
8.
Hawk Authentication – Protocolo de autenticação baseado em HMAC.
9.
AWS Signature – Autenticação baseada em assinatura usada para serviços Amazon AWS.
10.
Kerberos – Protocolo de autenticação de rede baseado em tickets.
11.
NTLM Authentication – Protocolo de autenticação desenvolvido pela Microsoft.
12.
Akamai EdgeGrid – Método de autenticação usado pela plataforma de API da Akamai.
13.
Customize – Permite que você defina e use métodos de autenticação que não são nativamente compatíveis com o Apidog.
Criar esquemas de segurança manualmente#
1
No seu projeto, navegue até
Components >
Security Schemes na barra lateral esquerda e clique em
New Security Scheme.
2
Selecione o tipo de esquema de segurança e preencha o nome e a configuração relevante.
3
Clique em
Save para concluir o processo de criação.
4
Na visualização de edição do esquema de segurança, clique em
Advanced Configuration na parte inferior da página.
O sistema exibirá o código OAS (OpenAPI Specification) do esquema de segurança atual, disponível nos formatos JSON e YAML.Você pode editar diretamente aqui para definir especificações mais complexas. O sistema atualizará as configurações do esquema de segurança com base nas suas alterações.Criar esquemas de segurança via importação OAS#
Ao importar um arquivo OpenAPI que inclui esquemas de segurança, o Apidog detectará e criará automaticamente os esquemas de segurança correspondentes. Eles aparecerão na lista Security Schemes do projeto.Você pode configurar o mapeamento entre Security e Auth ao importar arquivos OAS.Criar esquema de segurança OAuth 2.0#
OAuth 2.0 é um framework de autorização amplamente utilizado, e o Apidog oferece suporte completo a ele. Para criar um esquema de segurança OAuth 2.0, configure o seguinte:1.
Grant Type: escolha entre Authorization Code, Client Credentials, Implicit ou Password.
2.
URL Settings: com base no tipo de concessão selecionado, configure as URLs relevantes:Callback URL (também conhecida como Redirect URL)
3.
Scope Settings (defina os escopos de permissão que seu aplicativo pode solicitar):Adicione nomes e descrições de escopos
Configure diferentes conjuntos de escopos para cada tipo de concessão
4.
Clique no botão Test para abrir o painel de teste. Preencha o Client ID, Client Secret e outros campos obrigatórios para testar e verificar sua configuração do OAuth 2.0.
Modified at 2026-06-11 10:21:25
