Swagger 集成到 Dropwizard

Question

我对放置向导（dropwizard.io）相当陌生，刚刚完成了他们的教程。我想将 Swagger (swagger.io) 集成到这个示例应用程序中。 我发现：

• github.com/federecio/dropwizard-swagger-sample-app
• github.com/federecio/dropwizard-swagger

生成的 JSON 似乎非常相似，但是我无法扩展 REST 资源来查看它们各自的操作。 我注意到的唯一区别是 swagger 集成的示例代码使用 SERVER，而官方放置向导示例使用 APPLICATION

这里有一张图片

请您告诉我我的方法有什么问题吗？

这是我的方法的代码：https://github.com/geoHeil/dropwizardSwaggerIntegrationNotWorking

编辑：

for api - docs {
  "apiVersion": "0.0",
  "swaggerVersion": "1.2",
  "apis": [{
    "path": "/sample"
  }, {
    "path": "/hello-world",
    "description": "Operations about greetings"
  }]
}


for sample {
  "apiVersion": "0.0",
  "swaggerVersion": "1.2",
  "basePath": "http://geoHeil.local:8080",
  "resourcePath": "/sample",
  "apis": [{
    "path": "/sample",
    "operations": [{
      "method": "GET",
      "summary": "Sample endpoint",
      "notes": "",
      "type": "void",
      "nickname": "get",
      "authorizations": {},
      "parameters": []
    }]
  }, {
    "path": "/sample/hello-with-path-param/{name}",
    "operations": [{
      "method": "GET",
      "summary": "Sample endpoint with path param",
      "notes": "",
      "type": "void",
      "nickname": "getWithPathParam",
      "authorizations": {},
      "parameters": [{
        "name": "name",
        "required": true,
        "type": "string",
        "paramType": "path"
      }]
    }]
  }, {
    "path": "/sample/hello-with-query-param",
    "operations": [{
      "method": "GET",
      "summary": "Sample endpoint with query param",
      "notes": "",
      "type": "void",
      "nickname": "getWithQueryParam",
      "authorizations": {},
      "parameters": [{
        "name": "name",
        "required": false,
        "type": "string",
        "paramType": "query"
      }]
    }]
  }]
}

for hello - world {
  "apiVersion": "0.0",
  "swaggerVersion": "1.2",
  "basePath": "http://geoHeil.local:8080",
  "resourcePath": "/hello-world",
  "apis": [{
    "path": "/hello-world",
    "operations": [{
      "method": "GET",
      "summary": "Greetings endpoint",
      "notes": "",
      "type": "void",
      "nickname": "sayHello",
      "authorizations": {},
      "parameters": [{
        "name": "name",
        "required": false,
        "items": {
          "type": "string"
        },
        "paramType": "query"
      }]
    }]
  }]
}

Answer 1

现在有一个 Swagger 规范 2.0 示例可用：

https://github.com/swagger-api/swagger-samples/tree/master/java/java-dropwizard

这使用最新的 swagger 核心库，具有最小的依赖性。 注意，Jackson的版本需要从dropwizard的2.3.2更新到swagger的2.4.2。

Answer 2

我在生成的 JSON 中没有看到任何明显会导致操作无法扩展的内容。

但是，与 dropwizard-swagger 包捆绑在一起的 swagger-ui 有点旧了。我会尝试使用较新版本的 swagger-ui。

我不确定它是否会与捆绑的 swagger-ui 冲突，但基本上你需要克隆 https://github.com/swagger-api/swagger-ui 并将 /dist 目录复制到你的静态内容。

另一种选择是在本地运行 swagger-ui （仅用于测试目的），但打开 /dist/index.html 并将其指向您的 /api-docs 目录。但是，为了使其正常工作，您需要启用 CORS - https://github.com/swagger-api/swagger-ui#cors-support。

编辑：

我没有注意到您使用 JSON 编辑了问题，这使它更易于阅读。 GET /hello-world 操作有问题。看起来它应该接受一个字符串数组作为查询参数，但该参数在其定义中缺少

"type": "array"

。如果没有看到方法的声明及其注释，我无法说出可能是什么原因造成的，但这就是您应该查看的内容。