Projetando a segurança da API
Como parte do processo de design da API, você precisa especificar quais consumidores podem acessar sua API (autenticação) e o que eles têm permissão para fazer (autorização).
Você pode querer simplesmente definir uma segurança comum para toda a sua API, ou escolher uma política mais refinada com uma segurança específica para um recurso crítico.
Você também pode querer especificar que certas operações são livremente acessíveis sem autenticação.
O API Designer pode lidar com todos esses casos com os principais tipos de segurança:
- Autenticação básica
- Autenticação por portador
- Autenticação digest
- OAuth 1.0
- OAuth 2.0
- OpenID Connect
- Personalizado / Chave de API
- Passagem
Não há suporte para autenticação de cookie.
Criando um esquema de segurança
Crie um esquema de segurança para ser usado globalmente na sua versão de API ou em elementos individuais.
- Insira outros parâmetros específicos para o tipo selecionado.
Seu esquema de segurança foi criado, você pode usá-lo nas configurações globais da sua API ou em recursos e operações específicos.
Definindo a segurança da sua API
Defina esquemas de segurança para sua API, recursos e operações.
- Na seção Segurança global, adicione seus esquemas de segurança e selecione aqueles que você deseja aplicar globalmente à sua versão da API.
- Selecione um recurso e escolha os esquemas de segurança que você deseja aplicar a todas as operações do seu recurso. Alternativamente, você pode selecionar uma operação para definir sua segurança específica.
