版權(quán)聲明：本文為博主原創(chuàng)文章，未經(jīng)博主允許不得轉(zhuǎn)載。 https://blog.csdn.net/u010046908/article/details/55047193

1、Swagger2是什么？

Swagger 是一款RESTFUL接口的文檔在線自動(dòng)生成+功能測試功能軟件。
Swagger 是一個(gè)規(guī)范和完整的框架，用于生成、描述、調(diào)用和可視化 RESTful 風(fēng)格的 Web 服務(wù)。總體目標(biāo)是使客戶端和文件系統(tǒng)作為服務(wù)器以同樣的速度來更新。文件的方法，參數(shù)和模型緊密集成到服務(wù)器端的代碼，允許API來始終保持同步。Swagger 讓部署管理和使用功能強(qiáng)大的API從未如此簡單。

2、Swagger2官網(wǎng)

官網(wǎng)地址

3.Swagger2的入門教程

3.1Swagger2的maven依賴

<!-- 構(gòu)建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>

3.2RestApiConfig的配置

package com.lidong.dubbo.web.util;import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.ComponentScan; import org.springframework.context.annotation.Configuration; import org.springframework.web.servlet.config.annotation.EnableWebMvc; import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport; 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;/*** @項(xiàng)目名稱:lidong-dubbo* @類名:RestApiConfig* @類的描述: Restapi的基本配置* @作者:lidong* @創(chuàng)建時(shí)間:2017/2/11 上午10:01* @公司:chni* @QQ:1561281670* @郵箱:lidong1665@163.com* @使用方法：Restful API 訪問路徑: http://localhost:8080/lidong-dubbo-web/swagger-ui.html*/ @EnableWebMvc @EnableSwagger2 @Configuration @ComponentScan(basePackages ="com.lidong.dubbo") public class RestApiConfig extends WebMvcConfigurationSupport {@Beanpublic Docket createRestApi() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.lidong.dubbo.web")).paths(PathSelectors.any()).build();}private ApiInfo apiInfo() {return new ApiInfoBuilder().title("SpringMVC中使用Swagger2構(gòu)建RESTful APIs").termsOfServiceUrl("https://github.com/lidong1665").contact(new Contact("請叫我小東子","http://blog.csdn.net/u010046908","lidong1665@163.com")).version("1.0.0").build();}}

3.3在Controller中添加

@ApiOperation(value = "獲取用戶詳細(xì)信息", notes = "根據(jù)url的id來獲取用戶詳細(xì)信息")@ApiImplicitParam(name = "id", value = "用戶ID", required = true, dataType = "Long")@RequestMapping(value = "getUserForid/{id}", method = RequestMethod.GET)@ResponseBodypublic String getUser(@PathVariable int id) {try {return JsonUtil.bean2json(userService.getUserById(id));} catch (Exception e) {e.printStackTrace();}return null;}

3.4結(jié)果

代碼地址

總結(jié)

以上是生活随笔為你收集整理的dubbo2.5-spring4-mybastis3.2-springmvc4-mongodb3.4-redis3(十)之Spring MVC中使用 Swagger2 构建Restful API...的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。