O que são Esquemas de Segurança?#
Os esquemas de segurança são uma forma de definir como os seus endpoints são autenticados, seguindo a Especificação OpenAPI (OAS). Em vez de configurar a autenticação para cada endpoint individualmente, pode criar um modelo reutilizável (um esquema de segurança) que separa os métodos de autenticação das credenciais propriamente ditas. Isto facilita às equipas a gestão, atualização e reutilização das definições de autenticação de forma mais flexível.Porquê Utilizar Esquemas de Segurança?#
Defina Uma Vez, Utilize em Todo o Lado: Crie um esquema de segurança uma vez e reutilize-o em vários endpoints ou pastas.
Combinações Flexíveis: Um endpoint pode utilizar mais do que um tipo de esquema de segurança.
Separação entre Modelo e Valor: Mantenha as regras de autenticação (modelo) separadas dos valores reais (credenciais), o que facilita a manutenção.
Evita a Fuga de Credenciais: Ao testar endpoints com esquemas de segurança na documentação online, as credenciais têm de ser introduzidas manualmente.
Herda Automaticamente: Os endpoints podem herdar esquemas de segurança das respetivas pastas principais, reduzindo a configuração repetitiva.
Suporta Todos os Principais Métodos de Autenticação: Incluindo Chave de API, Token Bearer, Autenticação Básica, OAuth 2.0 e outros.
Compatível com OpenAPI: Totalmente compatível com a especificação de Esquemas de Segurança do OpenAPI 3.0.
Quando Deve Utilizá-los?#
Quando vários endpoints partilham o mesmo método de autenticação.
Quando um único endpoint requer vários tipos de autenticação.
Quando precisa de credenciais diferentes para ambientes diferentes.
Quando as equipas trabalham em conjunto e precisam de uma forma unificada de gerir a autenticação.
Quando pretende incluir definições de segurança claras e normalizadas na sua documentação OpenAPI.
Modified at 2026-06-09 08:54:45
