如何在Spring Boot Restful中设置样本Swagger参数/控制器

时间:2019-03-13 07:38:20

标签: java spring-boot swagger swagger-ui swagger-2.0

我正在尝试使用Swagger创建文档Spring Boot Restful。

以下内容:https://springfox.github.io/springfox/docs/current/ 我想为每个/ Controller API提供示例正文和标题参数。但到目前为止,我知道 Springfox文档


  • 在/ Get或/ Post映射中为URL上的示例参数添加此代码
  

例如@ApiParam(value =“ $ {param1.description}”)



  • 在Java模型中将此代码添加为Body上的示例参数
  

例如@ApiModelProperty(value =“ $ {property1.description}”)


但是我不想这样。我想集中样本文档。

我想为每个控制程序创建不同的Url参数和Body Paramater,但在Java类中 对于全局参数,它可以,但是对于每个/ Api来说如何?

这是全局参数的示例: 但是我如何拥有多个控制者,他说: 5 API 并在一个Class Java Config中添加示例正文。

@Bean
  public Docket apiDocket() {
    ParameterBuilder parameterBuilder = new ParameterBuilder();
    parameterBuilder.name("Authorization")
      .modelRef(new ModelRef("string"))
      .parameterType("header")
      .defaultValue("Basic qwerty")
      .required(true)
      .build();

    List<Parameter> parameters = new ArrayList<>();
    parameters.add(parameterBuilder.build());

    return new Docket(DocumentationType.SWAGGER_2)
      .select()
   .apis(RequestHandlerSelectors.basePackage("com.stackoverflow.swagger"))
      .paths(PathSelectors.any())
      .build()
      .apiInfo(getApiInfo())
      .globalOperationParameters(parameters);
  }

0 个答案:

没有答案