主页
产品
Red Hat Fuse
7.12
Apache Camel 组件参考
341.3. 在 API 文档中添加安全定义

341.3. 在 API 文档中添加安全定义

从 Camel 2.22.0 开始提供

Rest DSL 现在支持在生成的 API 文档中声明 Swagger securityDefinitions。例如，如下所示：

rest("/user").tag("dude").description("User rest service")
    // setup security definitions
    .securityDefinitions()
        .oauth2("petstore_auth").authorizationUrl("http://petstore.swagger.io/oauth/dialog").end()
        .apiKey("api_key").withHeader("myHeader").end()
    .end()
    .consumes("application/json").produces("application/json")

rest("/user").tag("dude").description("User rest service")
    // setup security definitions
    .securityDefinitions()
        .oauth2("petstore_auth").authorizationUrl("http://petstore.swagger.io/oauth/dialog").end()
        .apiKey("api_key").withHeader("myHeader").end()
    .end()
    .consumes("application/json").produces("application/json")

Copy to Clipboard

Toggle word wrap

在这里，我们设置了两个安全定义

OAuth2 - 带有通过提供的 url 的隐式授权
API Key - 使用来自名为 myHeader的 HTTP 标头的 api 键

然后，您需要通过引用其密钥(petstore_auth 或 api_key)来指定使用其他操作。

.get("/{id}/{date}").description("Find user by id and date").outType(User.class)
    .security("api_key")

...

.put().description("Updates or create a user").type(User.class)
    .security("petstore_auth", "write:pets,read:pets")

.get("/{id}/{date}").description("Find user by id and date").outType(User.class)
    .security("api_key")

...

.put().description("Updates or create a user").type(User.class)
    .security("petstore_auth", "write:pets,read:pets")

Copy to Clipboard

Toggle word wrap

此处 get 操作使用 Api Key 安全性，put 操作使用带有允许的读取和写入片断范围的 OAuth 安全性。

返回顶部

341.3. 在 API 文档中添加安全定义

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links