O que são esquemas de segurança?#
Esquemas de segurança são uma forma de definir como seus endpoints são autenticados, seguindo a OpenAPI Specification (OAS). Em vez de configurar a autenticação para cada endpoint individualmente, você pode criar um modelo reutilizável (um esquema de segurança) que separa os métodos de autenticação das credenciais reais. Isso facilita para as equipes gerenciar, atualizar e reutilizar configurações de autenticação com mais flexibilidade.Por que usar esquemas de segurança?#
Defina uma vez, use em todos os lugares: Crie um esquema de segurança uma vez e reutilize-o em vários endpoints ou pastas.
Combinações flexíveis: Um endpoint pode usar mais de 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 torna a manutenção mais fácil.
Evita vazamento de credenciais: Ao testar endpoints com esquemas de segurança na documentação online, as credenciais devem ser inseridas manualmente.
Herança automática: Endpoints podem herdar esquemas de segurança de suas pastas principais, reduzindo configurações repetitivas.
Compatível com todos os principais métodos de autenticação: Incluindo API Key, Bearer Token, Basic Auth, OAuth 2.0 e outros.
Compatível com OpenAPI: Totalmente compatível com a especificação Security Schemes do OpenAPI 3.0.
Quando você deve usá-los?#
Quando vários endpoints compartilham o mesmo método de autenticação.
Quando um único endpoint requer vários tipos de autenticação.
Quando você precisa de credenciais diferentes para ambientes diferentes.
Quando equipes estão trabalhando juntas e precisam de uma forma unificada de gerenciar a autenticação.
Quando você deseja incluir definições de segurança claras e padronizadas na sua documentação OpenAPI.
Modified at 2026-06-11 10:21:25
