Пользовательский интерфейс Swagger — параметр запроса

Я использую Swagger ui и ядро ​​Swagger (1.3) для трикотажного приложения. У меня есть определенные параметры запроса, которые я должен отправлять с каждым запросом, например, отправить, получить, удалить...

Как я могу сделать это по умолчанию?


java rest swagger swagger-ui jersey-1.0
person Jacaro    schedule 01.07.2015    source источник
comment
Не могли бы вы выбрать правильный ответ?   -  person Nelson G.    schedule 13.02.2017

Ответы (2)


arrow_upward
13
arrow_downward

Вы можете использовать аннотацию @ApiParam из аннотаций Swagger, чтобы настроить параметр запроса для использования из пользовательского интерфейса Swagger.

Например

@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

person ipeluffo    schedule 02.07.2015
comment
ApiParam для параметра запроса можно использовать только в том случае, если операция имеет такой параметр в своем определении. Но здесь я хочу отправить параметр запроса с URL-адресом, к которому будет осуществляться доступ, когда будет опробована операция публикации или получения или удаления. Надеюсь, вы понимаете, что я ищу - person Jacaro; 02.07.2015

arrow_upward
1
arrow_downward

Вы не можете, но начиная с 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"
        },
        ...
      }
    }
  },
  ...
}
person Nelson G.    schedule 01.07.2015