SpringBoot＋Swagger-ui自動生成API文檔

2024-07-14 08:43:39

字體：大中小

來源：轉載

供稿：網友

隨著互聯網技術的發展，現在的網站架構基本都由原來的后端渲染，變成了：前端渲染、先后端分離的形態，而且前端技術和后端技術在各自的道路上越走越遠。

這樣后段開發好了api 之后就要提交api 文檔給前端的朋友。給前端的api 文檔各個公司有各個公司的要求，有的是word 有的是 md 文檔，或者是 postman 的一個連接。

好了廢話不多說說一下 swagger -ui 吧

什么是Swagger

Swagger是一個Restful風格接口的文檔在線自動生成和測試的框架

官網：http://swagger.io

官方描述：The World's Most Popular Framework for APIs.

先看一下 swagger-ui 生成的api 的效果吧（這是一個增刪改查的小李子）

SpringBoot,Swagger-ui,自動生成API文檔

然后我們打開查詢所有用戶的api 看到api 內容

SpringBoot,Swagger-ui,自動生成API文檔

然后在服務器運行的狀態下點擊 try it out 測試查詢功能

SpringBoot,Swagger-ui,自動生成API文檔

接著打開新增的api 查看

SpringBoot,Swagger-ui,自動生成API文檔

好了這個就是自動生成的api 效果。接下來我們就看怎么在我們的項目中使用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@EnableSwagger2public class Swagger2 {  /**   * 創建API應用   * apiInfo() 增加API相關信息   * 通過select()函數返回一個ApiSelectorBuilder實例,用來控制哪些接口暴露給Swagger來展現，   * 本例采用指定掃描的包路徑來定義指定要建立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();  }  /**   * 創建該API的基本信息（這些基本信息會展現在文檔頁面中）   * 訪問地址：http://項目實際地址/swagger-ui.html   * @return   */  private ApiInfo apiInfo() {    return new ApiInfoBuilder()        .title("Spring Boot中使用Swagger2構建RESTful APIs")        .description("更多請關注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 調用方法   * 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 調用方法   * 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="返回刪除狀態1 成功 0 失敗")  public ResponseEntity<Object> deleteUser(@PathVariable Integer id) {    return new ResponseEntity<>(userService.removeUser(id.longValue()), HttpStatus.OK);  }}

注解含義：

@Api：用在類上，說明該類的作用。@ApiOperation：注解來給API增加方法說明。@ApiImplicitParams : 用在方法上包含一組參數說明。@ApiImplicitParam：用來注解來給方法入參增加說明。@ApiResponses：用于表示一組響應@ApiResponse：用在@ApiResponses中，一般用于表達一個錯誤的響應信息   code：數字，例如400   message：信息，例如"請求參數沒填好"   response：拋出異常的類  @ApiModel：描述一個Model的信息（一般用在請求參數無法使用@ApiImplicitParam注解進行描述的時候）@ApiModelProperty：描述一個model的屬性

注意：@ApiImplicitParam的參數說明：

SpringBoot,Swagger-ui,自動生成API文檔