当前位置:   article > 正文

Swagger-boostrap-ui Map/JSONObject -动态创建显示参数_swagger dynamicparameter

swagger dynamicparameter

1、修改配置文件

  1. @Configuration
  2. @EnableSwagger2
  3. @EnableSwaggerBootstrapUI
  4. @Import(BeanValidatorPluginsConfiguration.class)
  5. public class Swagger2 {
  6. private String basePackage="com.XXX";
  7. private String title="XXXX开发接口文档";
  8. /**
  9. * @Description:swagger2的配置文件,这里可以配置swagger2的一些基本的内容,比如扫描的包等等
  10. */
  11. @Bean
  12. public Docket createRestApi() {
  13. return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
  14. .apis(RequestHandlerSelectors.basePackage(basePackage))
  15. .paths(PathSelectors.any()).build();
  16. }
  17. /**
  18. * @Description: 构建 api文档的信息
  19. */
  20. private ApiInfo apiInfo() {
  21. return new ApiInfoBuilder()
  22. .title(title)
  23. .contact(new Contact("", "http://www.whbswdt.com", ""))
  24. .description("欢迎访问武汉百胜开发接口文档")
  25. .version("20.8.28").build();
  26. }
  27. }

2、注解使用

  1. @PostMapping("/createOrder421")
  2. @ApiOperation(value = "fastjson-JSONObject-动态创建显示参数")
  3. @ApiOperationSupport(params = @DynamicParameters(name = "CreateOrderModel",properties = {
  4. @DynamicParameter(name = "id",value = "注解id",example = "X000111",required = true,dataTypeClass = Integer.class),
  5. @DynamicParameter(name = "name",value = "订单编号",required = false)
  6. }))
  7. public Rest<JSONObject> createOrder12222(@RequestBody JSONObject jsonObject){
  8. Rest<JSONObject> r=new Rest<>();
  9. r.setData(jsonObject);
  10. return r;
  11. }
  12. @PostMapping("/createOrder422")
  13. @ApiOperation(value = "jdk-Map-动态创建显示参数")
  14. @DynamicParameters(name = "CreateOrderMapModel",properties = {
  15. @DynamicParameter(name = "id",value = "注解id",example = "X000111",required = true,dataTypeClass = Integer.class),
  16. @DynamicParameter(name = "name",value = "订单编号"),
  17. @DynamicParameter(name = "name1",value = "订单编号1"),
  18. @DynamicParameter(name = "orderInfo",value = "订单信息",dataTypeClass = Order.class),
  19. })
  20. public Rest<Map> createOrder12232(@RequestBody Map map){
  21. Rest<Map> r=new Rest<>();
  22. r.setData(map);
  23. return r;
  24. }

最终,页面效果呈现如下:

附上官方文档地址: https://doc.xiaominfo.com/guide/dynamic-parameter.html

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/从前慢现在也慢/article/detail/897685
推荐阅读
相关标签
  

闽ICP备14008679号