SpringBoot＋Swagger-ui如何自動生成API文檔
這篇文章主要介紹SpringBoot＋Swagger-ui如何自動生成API文檔，文中介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們一定要看完！
創(chuàng)新互聯(lián)建站專注于企業(yè)成都全網(wǎng)營銷推廣、網(wǎng)站重做改版、磐石網(wǎng)站定制設(shè)計(jì)、自適應(yīng)品牌網(wǎng)站建設(shè)、H5建站、商城開發(fā)、集團(tuán)公司官網(wǎng)建設(shè)、成都外貿(mào)網(wǎng)站制作、高端網(wǎng)站制作、響應(yīng)式網(wǎng)頁設(shè)計(jì)等建站業(yè)務(wù)，價(jià)格優(yōu)惠性價(jià)比高，為磐石等各大城市提供網(wǎng)站開發(fā)制作服務(wù)。
什么是Swagger
Swagger是一個Restful風(fēng)格接口的文檔在線自動生成和測試的框架
官網(wǎng)：http://swagger.io
官方描述：The World's Most Popular Framework for APIs.
先看一下 swagger-ui 生成的api 的效果吧
然后我們打開查詢所有用戶的api 看到api 內(nèi)容
然后在服務(wù)器運(yùn)行的狀態(tài)下點(diǎn)擊 try it out 測試查詢功能
接著打開新增的api 查看
好了這個就是自動生成的api 效果。接下來我們就看怎么在我們的項(xiàng)目中使用swagger-ui 吧
springboot 集成 swagger -ui
1、添加依賴
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.2.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.2.2</version> </dependency>
2、編寫配置文件
在application 同級目錄新建 Swagger2 文件
package com.abel.example;
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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
* Created by yangyibo on 2018/9/7.
*/
@Configuration
@EnableSwagger2
public class Swagger2 {
/**
* 創(chuàng)建API應(yīng)用
* apiInfo() 增加API相關(guān)信息
* 通過select()函數(shù)返回一個ApiSelectorBuilder實(shí)例,用來控制哪些接口暴露給Swagger來展現(xiàn)，
* 本例采用指定掃描的包路徑來定義指定要建立API的目錄。
* @return
*/
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.abel.example.controller"))
.paths(PathSelectors.any())
.build();
}
/**
* 創(chuàng)建該API的基本信息（這些基本信息會展現(xiàn)在文檔頁面中）
* 訪問地址：http://項(xiàng)目實(shí)際地址/swagger-ui.html
* @return
*/
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Spring Boot中使用Swagger2構(gòu)建RESTful APIs")
.description("更多請關(guān)注https://blog.csdn.net/u012373815")
.termsOfServiceUrl("https://blog.csdn.net/u012373815")
.contact("abel")
.version("1.0")
.build();
}
}3、在controller上添加注解，自動生成API
注意：
package com.abel.example.controller;
import javax.servlet.http.HttpServletRequest;
import java.util.Map;
import com.abel.example.bean.User;
import io.swagger.annotations.*;
import org.apache.log4j.Logger;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;
import com.abel.example.service.UserService;
import com.abel.example.util.CommonUtil;
@Controller
@RequestMapping(value = "/users")
@Api(value = "用戶的增刪改查")
public class UserController {
@Autowired
private UserService userService;
/**
* 查詢所有的用戶
* api :localhost:8099/users
* @return
*/
@RequestMapping(method = RequestMethod.GET)
@ResponseBody
@ApiOperation(value = "獲取用戶列表，目前沒有分頁")
public ResponseEntity<Object> findAll() {
return new ResponseEntity<>(userService.listUsers(), HttpStatus.OK);
}
/**
* 通過id 查找用戶
* api :localhost:8099/users/1
* @param id
* @return
*/
@RequestMapping(value = "/{id}", method = RequestMethod.GET)
@ResponseBody
@ApiOperation(value = "通過id獲取用戶信息", notes="返回用戶信息")
public ResponseEntity<Object> getUserById(@PathVariable Integer id) {
return new ResponseEntity<>(userService.getUserById(Long.valueOf(id)), HttpStatus.OK);
}
/**
* 通過spring data jpa 調(diào)用方法
* api :localhost:8099/users/byname?username=xxx
* 通過用戶名查找用戶
* @param request
* @return
*/
@RequestMapping(value = "/byname", method = RequestMethod.GET)
@ResponseBody
@ApiImplicitParam(paramType = "query",name= "username" ,value = "用戶名",dataType = "string")
@ApiOperation(value = "通過用戶名獲取用戶信息", notes="返回用戶信息")
public ResponseEntity<Object> getUserByUserName(HttpServletRequest request) {
Map<String, Object> map = CommonUtil.getParameterMap(request);
String username = (String) map.get("username");
return new ResponseEntity<>(userService.getUserByUserName(username), HttpStatus.OK);
}
/**
* 通過spring data jpa 調(diào)用方法
* api :localhost:8099/users/byUserNameContain?username=xxx
* 通過用戶名模糊查詢
* @param request
* @return
*/
@RequestMapping(value = "/byUserNameContain", method = RequestMethod.GET)
@ResponseBody
@ApiImplicitParam(paramType = "query",name= "username" ,value = "用戶名",dataType = "string")
@ApiOperation(value = "通過用戶名模糊搜索用戶信息", notes="返回用戶信息")
public ResponseEntity<Object> getUsers(HttpServletRequest request) {
Map<String, Object> map = CommonUtil.getParameterMap(request);
String username = (String) map.get("username");
return new ResponseEntity<>(userService.getByUsernameContaining(username), HttpStatus.OK);
}
/**
* 添加用戶啊
* api :localhost:8099/users
* @param user
* @return
*/
@RequestMapping(method = RequestMethod.POST)
@ResponseBody
@ApiModelProperty(value="user",notes = "用戶信息的json串")
@ApiOperation(value = "新增用戶", notes="返回新增的用戶信息")
public ResponseEntity<Object> saveUser(@RequestBody User user) {
return new ResponseEntity<>(userService.saveUser(user), HttpStatus.OK);
}
/**
* 修改用戶信息
* api :localhost:8099/users
* @param user
* @return
*/
@RequestMapping(method = RequestMethod.PUT)
@ResponseBody
@ApiModelProperty(value="user",notes = "修改后用戶信息的json串")
@ApiOperation(value = "新增用戶", notes="返回新增的用戶信息")
public ResponseEntity<Object> updateUser(@RequestBody User user) {
return new ResponseEntity<>(userService.updateUser(user), HttpStatus.OK);
}
/**
* 通過ID刪除用戶
* api :localhost:8099/users/2
* @param id
* @return
*/
@RequestMapping(value = "/{id}", method = RequestMethod.DELETE)
@ResponseBody
@ApiOperation(value = "通過id刪除用戶信息", notes="返回刪除狀態(tài)1 成功 0 失敗")
public ResponseEntity<Object> deleteUser(@PathVariable Integer id) {
return new ResponseEntity<>(userService.removeUser(id.longValue()), HttpStatus.OK);
}
}注解含義：
@Api：用在類上，說明該類的作用。 @ApiOperation：注解來給API增加方法說明。 @ApiImplicitParams : 用在方法上包含一組參數(shù)說明。 @ApiImplicitParam：用來注解來給方法入?yún)⒃黾诱f明。 @ApiResponses：用于表示一組響應(yīng) @ApiResponse：用在@ApiResponses中，一般用于表達(dá)一個錯誤的響應(yīng)信息 code：數(shù)字，例如400 message：信息，例如"請求參數(shù)沒填好" response：拋出異常的類 @ApiModel：描述一個Model的信息（一般用在請求參數(shù)無法使用@ApiImplicitParam注解進(jìn)行描述的時(shí)候） @ApiModelProperty：描述一個model的屬性
注意：@ApiImplicitParam的參數(shù)說明：
paramType會直接影響程序的運(yùn)行期，如果paramType與方法參數(shù)獲取使用的注解不一致，會直接影響到參數(shù)的接收。
4、啟動項(xiàng)目效果圖：
服務(wù)器啟動后訪問 http://localhost:8099/swagger-ui.html 效果如下
點(diǎn)擊查看效果
以上是“SpringBoot＋Swagger-ui如何自動生成API文檔”這篇文章的所有內(nèi)容，感謝各位的閱讀！希望分享的內(nèi)容對大家有幫助，更多相關(guān)知識，歡迎關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道！
當(dāng)前標(biāo)題：SpringBoot＋Swagger-ui如何自動生成API文檔
標(biāo)題URL：http://bm7419.com/article46/jjcjeg.html
成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供網(wǎng)站營銷、做網(wǎng)站、外貿(mào)網(wǎng)站建設(shè)、Google、網(wǎng)站排名、自適應(yīng)網(wǎng)站
聲明：本網(wǎng)站發(fā)布的內(nèi)容（圖片、視頻和文字）以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主，如果涉及侵權(quán)請盡快告知，我們將會在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場，如需處理請聯(lián)系客服。電話：028-86922220；郵箱：631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載，或轉(zhuǎn)載時(shí)需注明來源： 創(chuàng)新互聯(lián)
- 企業(yè)網(wǎng)站制作搶先注冊域名很有必要 2016-09-01
- 好的域名注冊是什么樣的？ 2014-03-11
- 域名注冊應(yīng)該怎樣選？ 2021-02-26
- 如何選擇安全的域名注冊機(jī)構(gòu)？ 2021-01-08
- 域名注冊需知 2022-07-13
- 佛山網(wǎng)站制作中域名注冊的問題 2022-11-30
- 新手注冊域名注意哪些？怎樣更好域名注冊？ 2021-02-17
- 你應(yīng)該避免的域名注冊和網(wǎng)站建設(shè)這些坑 2021-02-17
- 怎樣注冊域名 這種事宜要了解 2016-11-16
- 網(wǎng)站域名注冊5個問題 2021-09-09
- EDU.CN網(wǎng)絡(luò)域名注冊方法，edu域名怎么注冊？ 2019-11-15
- 企業(yè)網(wǎng)站建設(shè)中的域名注冊解析及服務(wù)器配置 2021-02-21