spring boot系列------swagger配置

随着互联网技术的发展,现在的网站架构基本都由原来的后端渲染,变成了:前端渲染、先后端分离的形态,而且前端技术和后端技术在各自的道路上越走越远。
前端和后端的唯一联系,变成了API接口;API文档变成了前后端开发人员联系的纽带,变得越来越重要,swagger就是一款让你更好的书写API文档的框架。
在没有提供api的工具之前,大家都是手写这些接口文档的,你有这种写法,他有那种写法,完全不统一,但是在swagger出现之后这一切就变得简单了,swagger的介绍我们这里就不多说了,自己去百度吧,但是好在这么好的api工具我们spring boot怎么可能没有呢?下面我就演示一下如何去配置swagger工具以及如何在spring boot 中使用它。
首先我们还是要搭建一个简单的demo,但是这次我们不能和上次一样,将controller写入到程序运行入口的类中,这次我们就要稍微规范点,我们将restful的接口全部放在controller层。好了废话不多说,我这边已经建立好了例子;我就直接使用这个列子不在一一敲打了:
这里写图片描述
还和之前一样,只是这次的进行了分层,不是之前的单一访问了,我们可以明显的发现我们这边多了一个叫swagger的java类,这个就是我们配置swagger的地方,进去看一下他的代码

@EnableSwagger2
@Configuration
public class Swagger2 {


    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.fiberhome.imc.Test"))//// 对指定包进行监控
                .paths(PathSelectors.any())// 对所有路径进行监控
                .build();
    }

这个类的最初加上了一个Configuration注解,表示是一个配置类,还有EnableSwagger2注解表示的是开启swaggerapi工具。
在使用swagger注解的时候要在pom文件里面添加一下这个依赖

 <dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.2.2</version>
</dependency>

好了我们swagger的配置也搞好了,现在我们要去controller去配置每一个访问的url的swagger
如图:
这里写图片描述
因为我们使用的是restful的接口,所以我们首先需要明确一下restful风格的接口建议我们怎么正确的使用method,我这边就简单说一下吧
GET:表示查询数据的时候使用
PUT:更新数据的时候使用
DELETE:删除数据的时候使用
POST:插入数据的时候使用
所以我们要根据自己的接口需求来使用相应的method。
好了接着上面的,我们要在每一个接口上面加上 @ApiOperation(value=”获取用户列表”, notes=”“)这个注解,这个注解是代表着我们队这个接口的解释。所有的配置完毕后,我们启动我们的项目后,我们访问http://localhost:8080/swagger-ui.html这个地址,就能看到一个这样的界面
这里写图片描述
而我们自己每个方法加了这个ApiOperation注解的都能在里面找到。我们也可以在里面测试这个接口,post、get等都能在里面显示,访问条件也会列举在右边,返回的状态码也会给我们列出,代表的是什么意思。至此我们swagger的配置就完成了,如果换成之前的ssh框架的话,可能不知道什么时候才能捣鼓出来,但是在boot里面只要几行注解就能完成。

猜你喜欢

转载自blog.csdn.net/u013825231/article/details/79686259