springMVC整合swagger2

时间 2019-11-13

标签 springmvc 整合 swagger2 swagger 栏目 Spring 繁體版

原文原文链接

1、What is swagger?

官方介绍：Swagger是一个规范且完整的框架，提供描述、生产、消费和可视化RESTful Web Service。
专业角度：Swagger是由庞大工具集合支撑的形式化规范。这个集合涵盖了从终端用户接口、底层代码库到商业API管理的方方面面。html

2、Why use the swagger?

讲个故事：在2014年时候，我和另外一个小伙伴加入到一个实验室，开始了咱们漫长的应用开发之路（这也是第一次作项目）。由于只有两我的，我作后台，他作Android，分工很明确的。在一开始，咱们并无关注API相关的内容，随手拈来，我说什么，他就调用什么。固然，也没有什么API文档提供。以致于到如今，我想更新升级系统，才发现，咱们写的代码是有多烂，连本身都不忍心去看的。因此说在项目开始就定一个契约，双方（前端后台）就API相关的内容，包括路径、参数、类型等达成一致，固然，这份契约并非一旦建立就不能修改的，并且，若是一开始没有设计好，颇有可能会频繁的修改。
做为一个很懒的码代码的猿呢，对于一些API的理解老是很模糊不清，可是，总想着能直接验证一下本身的理解就行了，而不是须要去项目写测试代码来验证本身的想法。因此说，API文档应该有直接运行的能力。而Swagger就是这样的一个东西，它能够为已有项目的生成具有执行能力的样式化API文档，这样能够极大的方便程序员对前端后台进行对接整合。

3、use the swagger

0.Spring MVC配置文件中的配置

前端

<span style="white-space:pre"> </span><context:component-scan base-package="com.jay.plat.config.controller" />
<mvc:default-servlet-handler />

1.maven依赖

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

2.Swagger配置文件

packagecom.jay.plat.config.util;

        importorg.springframework.context.annotation.Bean;
        importorg.springframework.context.annotation.ComponentScan;
        importorg.springframework.context.annotation.Configuration;
        importorg.springframework.web.servlet.config.annotation.EnableWebMvc;
        importorg.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
        importspringfox.documentation.builders.ApiInfoBuilder;
        importspringfox.documentation.builders.PathSelectors;
        importspringfox.documentation.builders.RequestHandlerSelectors;
        importspringfox.documentation.service.ApiInfo;
        importspringfox.documentation.spi.DocumentationType;
        importspringfox.documentation.spring.web.plugins.Docket;
        importspringfox.documentation.swagger2.annotations.EnableSwagger2;

/*
*RestfulAPI访问路径:
*http://IP:port/{context-path}/swagger-ui.html
*eg:http://localhost:8080/jd-config-web/swagger-ui.html
*/
@EnableWebMvc
@EnableSwagger2
@ComponentScan(basePackages = {"com.<spanstyle="font - family:Arial, Helvetica, sans-serif;">jay.</span>plat.config.controller"})
@Configuration
publicclassRestApiConfigextendsWebMvcConfigurationSupport{

@Bean
publicDocketcreateRestApi(){
        returnnewDocket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        .apis(RequestHandlerSelectors.basePackage("com.jay.plat.config.controller"))
        .paths(PathSelectors.any())
        .build();
        }

        privateApiInfoapiInfo(){
        returnnewApiInfoBuilder()
        .title("Spring中使用Swagger2构建RESTfulAPIs")
        .termsOfServiceUrl("http://blog.csdn.net/he90227")
        .contact("逍遥飞鹤")
        .version("1.1")
        .build();
        }
}

配置说明：java

@Configuration 配置注解，自动在本类上下文加载一些环境变量信息
@EnableWebMvc
@EnableSwagger2 使swagger2生效
@ComponentScan("com.myapp.packages") 须要扫描的包路径

3.Controller中使用注解添加API文档

packagecom.jay.spring.boot.demo10.swagger2.controller;

        importjava.util.ArrayList;
        importjava.util.Collections;
        importjava.util.HashMap;
        importjava.util.List;
        importjava.util.Map;

        importorg.springframework.web.bind.annotation.PathVariable;
        importorg.springframework.web.bind.annotation.RequestBody;
        importorg.springframework.web.bind.annotation.RequestMapping;
        importorg.springframework.web.bind.annotation.RequestMethod;
        importorg.springframework.web.bind.annotation.RestController;

        importcom.jay.spring.boot.demo10.swagger2.bean.User;

        importio.swagger.annotations.ApiImplicitParam;
        importio.swagger.annotations.ApiImplicitParams;
        importio.swagger.annotations.ApiOperation;

@RestController
@RequestMapping(value = "/users")//经过这里配置使下面的映射都在/users下，可去除
publicclassUserController{

        staticMap<Long, User>users=Collections.synchronizedMap(newHashMap<Long, User>());

@ApiOperation(value = "获取用户列表", notes = "")
@RequestMapping(value = {""}, method = RequestMethod.GET)
        publicList<User>getUserList(){
        List<User>r=newArrayList<User>(users.values());
        returnr;
        }

@ApiOperation(value = "建立用户", notes = "根据User对象建立用户")
@ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User")
@RequestMapping(value = "", method = RequestMethod.POST)
        publicStringpostUser(@RequestBodyUseruser){
        users.put(user.getId(),user);
        return"success";
        }

@ApiOperation(value = "获取用户详细信息", notes = "根据url的id来获取用户详细信息")
@ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long")
@RequestMapping(value = "/{id}", method = RequestMethod.GET)
        publicUsergetUser(@PathVariableLongid){
        returnusers.get(id);
        }

@ApiOperation(value = "更新用户详细信息", notes = "根据url的id来指定更新对象，并根据传过来的user信息来更新用户详细信息")
@ApiImplicitParams({@ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long"),
        @ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User")})
@RequestMapping(value = "/{id}", method = RequestMethod.PUT)
        publicStringputUser(@PathVariableLongid,@RequestBodyUseruser){
        Useru=users.get(id);
        u.setName(user.getName());
        u.setAge(user.getAge());
        users.put(id,u);
        return"success";
        }

@ApiOperation(value = "删除用户", notes = "根据url的id来指定删除对象")
@ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long")
@RequestMapping(value = "/{id}", method = RequestMethod.DELETE)
        publicStringdeleteUser(@PathVariableLongid){
        users.remove(id);
        return"success";
        }

        }

4.效果展现程序员

Restful API 访问路径:
* http://IP:port/{context-path}/swagger-ui.html
* eg:http://localhost:8080/jd-config-web/swagger-ui.html

参考http://blog.csdn.net/jia20003/article/details/50700736web