小編給大家分享一下Spring boot集成swagger2如何生成接口文檔，希望大家閱讀完這篇文章之后都有所收獲，下面讓我們一起去探討吧！
站在用戶的角度思考問題，與客戶深入溝通，找到蟠龍網(wǎng)站設(shè)計(jì)與蟠龍網(wǎng)站推廣的解決方案，憑借多年的經(jīng)驗(yàn)，讓設(shè)計(jì)與互聯(lián)網(wǎng)技術(shù)結(jié)合，創(chuàng)造個(gè)性化、用戶體驗(yàn)好的作品，建站類型包括：成都網(wǎng)站制作、成都做網(wǎng)站、企業(yè)官網(wǎng)、英文網(wǎng)站、手機(jī)端網(wǎng)站、網(wǎng)站推廣、域名與空間、網(wǎng)絡(luò)空間、企業(yè)郵箱。業(yè)務(wù)覆蓋蟠龍地區(qū)。
一、Swagger介紹
Swagger是一個(gè)規(guī)范和完整的框架，用于生成、描述、調(diào)用和可視化RESTful風(fēng)格的web服務(wù)。目標(biāo)是使客戶端和文件系統(tǒng)作為服務(wù)器以同樣的速度來更新文件的方法，參數(shù)和模型緊密集成到服務(wù)器。這個(gè)解釋簡單點(diǎn)來講就是說，swagger是一款可以根據(jù)restful風(fēng)格生成的接口開發(fā)文檔，并且支持做測試的一款中間軟件。
二、使用swagger優(yōu)勢
1、對于后端開發(fā)人員來說
不用再手寫Wiki接口拼大量參數(shù)，避免手寫錯(cuò)誤
對代碼侵入性低，采用全注解的方式，開發(fā)簡單
方法參數(shù)名修改、新增、減少參數(shù)都可以直接生效，不用手動維護(hù)
缺點(diǎn)：增加了開發(fā)成本，寫接口還得再寫一套參數(shù)配置
2、對前端開發(fā)來說
3、對于測試來說
三、springboot集成swagger使用
1、新建maven項(xiàng)目（結(jié)構(gòu)如下：）
2、配置pom.xml文件
4.0.0
org.springframework.boot
spring-boot-starter-parent
2.1.3.RELEASE
com.dds.sbswagger
sb-swagger
0.0.1-SNAPSHOT
sb-swagger
Demo project for Spring Boot
1.8
org.springframework.boot
spring-boot-starter-web
org.springframework.boot
spring-boot-starter-test
test
io.springfox
springfox-swagger2
2.9.2
io.springfox
springfox-swagger-ui
2.9.2
org.projectlombok
lombok
1.18.6
org.springframework.boot
spring-boot-maven-plugin
3、程序啟動類
package com.dds.sbswagger;
import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
/**
* @author dds
*/
@SpringBootApplication
@Slf4j
public class SbSwaggerApplication {
public static void main(String[] args) {
SpringApplication.run(SbSwaggerApplication.class, args);
log.info("\n----------------------------------------------------------\n\t" +
"Application demo is running! Access URLs:\n\t" +
"swagger-ui: \thttp://127.0.0.1:8080/swagger-ui.html\n\t" +
"----------------------------------------------------------");
}
}4、SwaggerConfig配置類
package com.dds.sbswagger.config;
import io.swagger.annotations.ApiOperation;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
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;
import java.util.Collections;
/**
* @author DDS
* @date 2019/9/10 13:55
*/
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("com.dds.sbswagger.controller"))
//加了ApiOperation注解的類，才生成接口文檔
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
.paths(PathSelectors.any())
.build()
.apiInfo(apiInfo());
}
private ApiInfo apiInfo() {
return new ApiInfo(
"Spring Boot項(xiàng)目集成Swagger實(shí)例文檔",
"我的微信公眾號：大道七哥，歡迎大家關(guān)注。",
"API V1.0",
"Terms of service",
new Contact("大道七哥", "https://www.cnblogs.com/jstarseven/", "jstarseven@163.com"),
"Apache", "http://www.apache.org/", Collections.emptyList());
}
}5、實(shí)體類model
package com.dds.sbswagger.model;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
/**
* @author DDS
* @date 2019/9/10 13:55
*/
@ApiModel("用戶實(shí)體")
@Data
public class User {
/**
* 用戶Id
*/
@ApiModelProperty("用戶id")
private int id;
/**
* 用戶名
*/
@ApiModelProperty(value = "用戶姓名", example = "zhangdan", required = true)
private String name;
/**
* 用戶地址
*/
@ApiModelProperty(value = "用戶地址", example = "北京市海淀區(qū)", required = true)
private String address;
/**
* 用戶手機(jī)號
*/
@ApiModelProperty(value = "用戶手機(jī)號", example = "15689652367", required = true)
private String phone;
/**
* 用戶年齡
*/
@ApiModelProperty(value = "用戶年齡", example = "24", required = true)
private Integer age;
}6、接口開發(fā)
package com.dds.sbswagger.controller;
import com.dds.sbswagger.model.User;
import io.swagger.annotations.*;
import org.springframework.web.bind.annotation.*;
/**
* @author DDS
* @date 2019/9/10 13:55
*/
@RestController
@RequestMapping("/user")
@Api(tags = "用戶相關(guān)接口", description = "提供用戶相關(guān)的Rest API")
public class UserController {
@PostMapping("/add")
@ApiOperation(value = "新增用戶接口", notes = "手機(jī)號、密碼都是必輸項(xiàng)，年齡隨邊填，但必須是數(shù)字")
@ApiImplicitParams({
@ApiImplicitParam(name = "name", value = "用戶名稱", required = true, paramType = "form"),
@ApiImplicitParam(name = "address", value = "用戶地址", required = true, paramType = "form"),
@ApiImplicitParam(name = "phone", value = "用戶手機(jī)號", required = true, paramType = "form"),
@ApiImplicitParam(name = "age", value = "用戶年齡", required = true, paramType = "form", dataType = "Integer")
})
public boolean addUser(@RequestBody User user) {
return false;
}
@ApiOperation("通過id查找用戶接口")
@GetMapping("/find/{id}")
public User findById(@PathVariable("id") int id) {
return new User();
}
@ApiOperation("更新用戶信息接口")
@PutMapping("/update")
@ApiResponses({
@ApiResponse(code = 400, message = "請求參數(shù)沒填好"),
@ApiResponse(code = 404, message = "請求路徑?jīng)]有或頁面跳轉(zhuǎn)路徑不對"),
@ApiResponse(code = 405, message = "未知錯(cuò)誤")
})
public boolean update(@RequestBody User user) {
return true;
}
@ApiOperation("刪除用戶接口")
@DeleteMapping("/delete/{id}")
public boolean delete(@PathVariable("id") int id) {
return true;
}
}7、swagger界面顯示
看完了這篇文章，相信你對“Spring boot集成swagger2如何生成接口文檔”有了一定的了解，如果想了解更多相關(guān)知識，歡迎關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道，感謝各位的閱讀！
網(wǎng)頁題目：Springboot集成swagger2如何生成接口文檔
鏈接分享：
http://weahome.cn/article/goeeeh.html
重慶分公司
重慶分公司
