Swagger配置以指定身份验证架构

时间:2018-01-30 11:27:13

标签: java swagger

我已经指定了Swagger注释,用于生成API所需的安全/身份验证;根据Swagger文档。

 @ApiOperation(value = "Add a new pet to the store", 
    authorizations = {
          @Authorization(
                  value="petoauth", 
                  scopes = {
                          @AuthorizationScope(
                                  scope = "add:pet", 
                                  description = "allows adding of pets")
                          }
                  )
    }
  )

添加此代码并生成文档后,作为文档的一部分,我看到" Type"安全部分设置为"未知"。 我可以控制它并将其设置为任何自定义值吗?

1 个答案:

答案 0 :(得分:0)

进一步研究发现,虽然指定了swagger-maven-plugin并在pom(模块的pom.xml)下配置它,但在那里指定了这个配置:

<securityDefinition>
    <name>basicAuth</name>
    <type>basic</type>
</securityDefinition>

(其中一个Stackoverflow回答指出这个没有太多细节,但错过了相同的链接。如果有人找到它,请在这里链接以给予应有的信用)

另外,这里需要注意的是类型值。这些必须是: - 基本的 - oauth2 (有人可以在这一点上纠正我,但根据我的观察发现了这一点)