搭建swagger

1.创建项目(引入两个依赖就可以了)

搭建swagger_第1张图片
搭建swagger_第2张图片
搭建swagger_第3张图片
搭建swagger_第4张图片

2.没啥用的删掉

搭建swagger_第5张图片

3.导入依赖包

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

搭建swagger_第6张图片

4.启动项目

搭建swagger_第7张图片
默认的/error方法
搭建swagger_第8张图片

5.写个controller测试,访问test方法

搭建swagger_第9张图片
搭建swagger_第10张图片

6.创建Swagger配置文件

搭建swagger_第11张图片

7.打开http://localhost:8080/swagger-ui.html(jar包里面的页面),发现有个默认的errorController,还有自己编写的testController

搭建swagger_第12张图片

搭建swagger_第13张图片

8.修改页面上的信息(配置swagger的bean实例Docket)

搭建swagger_第14张图片

8.1是否启用swagger

搭建swagger_第15张图片
搭建swagger_第16张图片
这里控制只能在dev环境使用swagger
搭建swagger_第17张图片

8.2配置swagger信息
搭建swagger_第18张图片

@Configuration   //配置
@EnableSwagger2  //使用Swagger2
public class swaggerConfig {

    //修改页面上的信息(配置swagger的bean实例Docket)
    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo());
    }

    private ApiInfo apiInfo() {
        return new ApiInfo(
                "Swagger文档",//标题
                "搭建swagger",//描述
                "v1.0",//版本
                "https://blog.csdn.net/weixin_4269/1149",//团队服务地址
                new Contact("夜一", "https://blog.csdn.net/weixin_42691149", "[email protected]"),//作者信息
                "Apache 2.0",//来源版本号
                "http:www.apache.org/license/LICENSE-2.0",//开源版本地址
                new ArrayList()
        );
    }


}

搭建swagger_第19张图片
8.3控制页面上controller的显示
搭建swagger_第20张图片
搭建swagger_第21张图片
8.4配置分组.groupName
在这里插入图片描述

搭建swagger_第22张图片
搭建swagger_第23张图片
8.5 pojo类的显示
搭建swagger_第24张图片
搭建swagger_第25张图片
只要返回的对象是pojo,那么就会显示

搭建swagger_第26张图片

9.注释

搭建swagger_第27张图片
搭建swagger_第28张图片
搭建swagger_第29张图片

你可能感兴趣的:(swagger)