浅谈Api框架神器Swagger2

Api框架神器Swagger2

Swagger被称为世界最强的的Api框架，没有之一。（有点狂妄）

下面我们来简单了解一下swagger，基于前后端分离开发，在相互交互时产生的需求。传统方法在联调的时候，无法及时的协商，前后端容易出现冲突，swagger大大降低了工作的难度。

我们演示在spring boot下集成swagger2：

1.新建spring boot项目（使用idea开发工具）

2.导入相关的依赖

<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>

这里是swagger2使用到的两个依赖，可以从maven仓库中下载，导入之后记得刷新maven。

3.编写简单的工程

我们新建一个controller，编写一个hello工程。

@RestController
public class HelloController {
    @RequestMapping("/hello")
    public String hello(){
        return "hello";
    }
}

4.配置swagger信息

新建一个SwaggerConfig的class

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    //配置swagger中的docket实例
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //分组操作
                .groupName("张巍警")
                .select()
                //指定要扫描的包
                .apis(RequestHandlerSelectors.basePackage("cn.bd13.demo.controller"))
                //过滤的路径
                .paths(PathSelectors.any())
                .build();
    }
    //配置apiinfo的信息
    public ApiInfo apiInfo(){
        Contact contact = new Contact("张巍警", "https://gitee.com/zhang_wei_jing/otaku_time.git", "[email protected]");
        return new ApiInfo(
                "宅男swagger2",
                "不可描述的东西",
                "1.0",
                "https://gitee.com/zhang_wei_jing/otaku_time.git",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList());
    }
}

启动项目，url+swagger-ui.html

这里就可以显示出我们的接口文档，当然也可以添加很多注释。

//在类名上声明
@Api(tags = "这是hello的方法")

//在方法上声明
@ApiOperation(value = "这是用户登录的方法")
@ApiImplicitParams({
	//默认值
        @ApiImplicitParam(name = "name" ,example = "zwj" ,required = true),
        @ApiImplicitParam(name = "password" ,example = "111" ,required = true)
})
@ApiResponses({
	//配合token使用
        @ApiResponse(code = 400 ,message = "数据库没有返回值"),
        @ApiResponse(code = 501 ,message = "数据库操作有误"),
        @ApiResponse(code = 502 ,message = "JAVA操作有误"),
        @ApiResponse(code = 503 ,message = "REDIS操作有误")
})

有了swagger，再也不怕前后端撕逼啦。。。。。
真香！！
由于自己在学习前端框架，断更了许久，照旧，给各位看官分享一句话，
人生何其美好，愿各位都能活得烈马青葱，不为他人目光所累。
加油！