java - Swagger ui - 查询参数

Question

我正在将 Swagger ui 和 Swagger core (1.3) 用于球衣应用程序。我有某些查询参数，我必须随每个请求发送，例如发布、获取、删除......

我怎么能默认这个？

Answer 1

您可以使用@ApiParamSwagger 注释中的注释来配置要从 Swagger-UI 使用的查询参数。

例如

@Path("/{username}")
@ApiOperation(value = "Updated user")
public Response updateUser(
  @ApiParam(value = "description for query-parameter") @QueryParam("username") String username
) {
...
}

请在以下官方文档中阅读有关此注释的更多信息： https ://github.com/swagger-api/swagger-core/wiki/Annotations#apiparam

Answer 2

你不能，但是从 swagger 2.0 开始（我不知道这是否被 swagger-code/swagger-ui 支持），你可以定义要跨操作重用的参数。

例如 ：

{
  "parameters": {
    "pageParam": {
      "name": "page",
      "in": "query",
      "description": "page number to get",
      "required": false,
      "type": "integer",
      "format": "int32"
    }
  },
  "paths": {
    "/customers": {
      "get":  {
        "description": "Retrive list of customers",
        "parameters": {
          "$ref": "#/parameters/pageParam"
        },
        ...
      }
    }
  },
  ...
}