SpringMVC中使用Swagger2整合

 

• Swagger2是什么

 

Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。 
Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。Swagger 让部署管理和使用功能强大的API从未如此简单。

• Swagger2官网

官网地址 

• Swagger2的入门教程

  • Swagger2的maven依赖

<!-- 构建Restful API -->
            <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>

• • RestApiConfig的配置

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.robot.controller.api")).paths(PathSelectors.any()).build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("SpringMVC中使用Swagger2整合").termsOfServiceUrl("https://git.oschina.net/suntea")
                .contact(new Contact("hello", "http://www.cnblogs.com/hjava/", "[email protected]")).version("1.0.0").build();
    }
}

• • 在Controller中添加　　

@Api(value = "Api控制器")
@Controller
@RequestMapping("/api")
public class ApiConfigController {

    @ApiResponse(code = 200, message = "success", response = Result.class)
    @ApiOperation(value = "获取用户对象", httpMethod = "GET", response = String.class, notes = "根据用户名获取用户对象")
    @RequestMapping(value = "apiGetId", method = RequestMethod.GET, produces = "application/json")
    @ResponseBody
    public Object getId(@ApiParam(name = "userId", required = true, value = "用户Id") @RequestParam("id") String id) {
        Result res = new Result();
        res.setMsg("msg=" + id);
        res.setSuccess(true);
        return res;
    }
}

• • 　　结果

以上就完成了。有问题请留言。