如何将swagger与akka-http一起使用

Question

我正在尝试使用swagger记录akka-超文本传输协议API

我拥有的是：

@Path("/foo")
@Api(value = "/foo", produces = "application/json")
class FooService ...

@ApiOperation(value = "Get list of all foos", nickname = "getAllFoos", httpMethod = "GET",
response = classOf[Foo], responseContainer = "Set")
def getAll: Route = get {...

这会生成一个json，我可以在swagger UI中查看它。但是，我不能使用生成的示例，因为缺少auth选项。

我没有找到任何使用swagger-akka-http的例子，只有一些使用yaml config的例子

在< code>yaml中，可能是这样的:

securityDefinitions:
  basicAuth:
    type: basic
    description: HTTP Basic Authentication.

但是，我没有yaml。除了通过注释之外，我也不能控制生成的.json。

在IIUC中，提及auth方法的正确位置是Api或APIOoperationannotation的authorizations。此参数应包含授权注释的数组。

每个＜code＞授权＜code＞注释的＜code＞值

但是我不知道如何使用注释定义这个< code > SecurityDefinitionObject 。

Authoration注释不应该独立使用，如果是，则将被忽略。

我错过了什么吗？我是否需要一个额外的 yaml 或 json 文件，其中包含其他声明，如果我这样做，我应该把它放在哪里？还有更多别的吗？

非常感谢。

编辑

使用 0.7.2-SNAPSHOT，正在生成的基本身份验证数组是这样的：

paths: {
    /foos: {
        get: {
        security: [
            {
            basicAuth: [ ]
            }
        ],

现在唯一的问题是让Swagger UI正确解释它并在示例中使用身份验证。AFAIK，如果您需要UI中的基本身份验证，您必须自己添加它，就像这里描述的那样

Answer 1

我目前维护swagger-akka-http。

代码几乎是代码库的一个薄包装swagger.io。

@Api和@APIOoperation注释支持授权参数。

https://github.com/swagger-api/swagger-core/blob/master/modules/swagger-annotations/src/main/java/io/swagger/annotations/Api.java

@Api(value = "/myApi", description = "My API", produces = "application/json", 
authorizations=Array(new Authorization(value="basicAuth")))

我从未使用过这个功能，但也许你可以尝试一下。