Spring Boot 集成Swagger2

最新推荐文章于 2024-06-11 09:52:37 发布

原创最新推荐文章于 2024-06-11 09:52:37 发布 · 642 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#swagger #springboot

spring 同时被 2 个专栏收录

10 篇文章

订阅专栏

swagger

1 篇文章

订阅专栏

本文详细介绍了如何在项目中集成并使用Swagger2进行API文档的自动生成。从配置pom.xml引入Swagger2依赖开始，到编写Swagger配置类，再到创建测试控制器，并提供了完整的示例代码。

第一步：在pom.xml文件中引入Swagger2的包

  <properties>
    <springfox.version>2.2.2</springfox.version>
  </properties>

    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>${springfox.version}</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>${springfox.version}</version>
    </dependency>

第二步：编写Swagger的控制类

@Configuration
@EnableSwagger2
public class SwaggerConfiguration implements EnvironmentAware {
    private final Logger log = LoggerFactory.getLogger(SwaggerConfiguration.class);
    public static final String DEFAULT_INCLUDE_PATTERN = "/.*";
    private RelaxedPropertyResolver propertyResolver;

    @Override
    public void setEnvironment(Environment environment) {
        this.propertyResolver = new RelaxedPropertyResolver(environment, "swagger.");
    }

    @Bean
    public Docket swaggerSpringfoxDocket() {
        StopWatch watch = new StopWatch();
        watch.start();
        Docket swaggerSpringMvcPlugin = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .genericModelSubstitutes(ResponseEntity.class)
                .select()
                //设置需要扫描的web包路径，去掉自带的BaseErrorController测试接口,只显示自己包下面的接口
                .apis(RequestHandlerSelectors.basePackage("com.vx.jk"))  
                .paths(regex(SwaggerConfiguration.DEFAULT_INCLUDE_PATTERN)) 
                .build();
        watch.stop();
        return swaggerSpringMvcPlugin;
    }

    private ApiInfo apiInfo() {
        return new ApiInfo(
                propertyResolver.getProperty("title"),
                propertyResolver.getProperty("description"),
                propertyResolver.getProperty("version"),
                propertyResolver.getProperty("termsOfServiceUrl"),
                propertyResolver.getProperty("contact"),
                propertyResolver.getProperty("license"),
                propertyResolver.getProperty("licenseUrl")
        );
    }

}

第三步：写一个测试的web类

package com.vx.jk.web;

@RestController
@RequestMapping("jk")
@Api(value = "测试Controller", description = "测试类")  
public class PhotoPriceController {

    private static Logger LOG = LoggerFactory.getLogger(PhotoPriceController.class);

    /*
    @ApiOperation(value = “接口说明”, httpMethod = “接口请求方式”, response = “接口返回参数类型”, notes = “接口发布说明”；其他参数可参考源码；
    @ApiParam(required = “是否必须参数”, name = “参数名称”, value = “参数具体描述”
    @RequestParam(value = "id") 再get请求时，已id=数据值的形式拼接到url的?后面，如果不加，参数可能接受不到数据
    @RequestBody 添加在输入参数上时，标识输入的数据是一个body体对象，如果不加，post提交的对象数据，参数可能接受不到数据,并且一个接口只能有一个body参数
     */
    @ApiOperation(value = "输入ID",httpMethod="GET", notes = "返回字符串", response = String.class)
    @RequestMapping(value = "/home", method = RequestMethod.GET)
    public String home(@ApiParam(name="id", value="编号", required=true)@RequestParam(value = "id") String id,
                                        HttpServletRequest request){
        System.out.println(id+"------"+request.getParameter("id"));
        return "helloworld"+id;
    }
}