Sringboot整合swagger

1、引入依赖

​ 放入pom.xml文件中的下

<!--swagger-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.7.0</version>
</dependency>
<!--swagger ui-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.7.0</version>
</dependency>

2、创建Swagger配置类

@Configuration
@EnableSwagger2
public class Swagger2Config {

    @Bean
    public Docket adminApiConfig(){

        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("adminApi")
                .apiInfo(adminApiInfo())
                .select()
                //只显示admin路径下的页面
                .apis(RequestHandlerSelectors.basePackage("com.test.controller")) //需要自行修改扫描项目controller层路径
                .build();

    }
    private ApiInfo adminApiInfo(){

        return new ApiInfoBuilder()
                .title("后台管理系统-API文档")
                .description("本文档描述了后台管理系统微服务接口定义")
                .version("1.0")
                .contact(new Contact("域名", "网址", "邮箱")) //可自行设置
                .build();
    }


}

3、 对Controller层接口进行Api注解

例如：

@Api(tags = "文章设置管理") //此注解为swagger-ui界面中controller层的功能解释
@RestController
@RequestMapping("/article")
public class ArticleController {
//            * 根据id获取一个
     @Autowired
     private ArticleService articleService;
     @ApiOperation("根据文章ID查询")  //此注解为swagger-ui界面中controller层下的接口的功能解释
     @GetMapping("/getOneById/{aid}")
     public ResponseVO<Article> getOneById(@PathVariable("aid") Integer aid) {
         Article article = articleService.getOneById(aid);
         //阅读量加一
         articleService.addReadNum(aid);
         return new ResponseVO<Article>().setStatus(200).setData(article);

     }

4、从页面上访问swagger的ui界面（可视化）

etStatus(200).setData(article);

 }

# 4、从页面上访问swagger的ui界面（可视化）
localhost:端口号/项目默认路径例如（csdn）/swagger-ui.html