什么是安全方案?#
安全方案是一种按照 OpenAPI Specification(OAS)定义端点如何进行身份验证的方式。你无需为每个端点单独设置身份验证,而是可以创建一个可复用的模板(安全方案),将身份验证方法与实际凭据分离。这使团队能够更灵活地管理、更新和复用身份验证设置。为什么使用安全方案?#
定义一次,到处使用:创建一次安全方案,并在多个端点或文件夹中复用。
模板与值分离:将身份验证规则(模板)与实际值(凭据)分开,使维护更加容易。
防止凭据泄露:在在线文档中使用安全方案测试端点时,必须手动输入凭据。
自动继承:端点可以从其父文件夹继承安全方案,减少重复设置。
支持所有主流身份验证方法:包括 API Key、Bearer Token、Basic Auth、OAuth 2.0 等。
符合 OpenAPI 标准:完全兼容 OpenAPI 3.0 Security Schemes 规范。
什么时候应该使用它?#
当你希望在 OpenAPI 文档中包含清晰、标准化的安全定义时。
Modified at 2026-06-09 08:55:47