接口文檔生成工具Swagger2

時間 2020-06-22

標籤接口文檔生成工具 swagger2 swagger 简体版

原文原文鏈接

前言：

　　在當下先後端分離開發和微服務大行其道的狀況下，微服務及先後端分離後，先後端並行開發，這樣溝通成本就增長了。因此一款強大的RESTful API文檔就相當重要。而目前在後端領域，html

基本上是Swagger的天下了。前端

什麼是Swagger?　　

　　Swagger 是一個規範和完整的框架，用於生成、描述、調用和可視化 RESTful 風格的 Web 服務。整體目標是使客戶端和文件系統做爲服務器以一樣的速度來更新。java

文件的方法，參數和模型緊密集成到服務器端的代碼，容許API來始終保持同步。spring

能夠解決什麼問題？

　　一、建立文檔成本高：因爲接口衆多，而且細節複雜（須要考慮不一樣的HTTP請求類型、HTTP頭部信息、HTTP請求內容等）。json

　　二、維護文檔成本高：修改接口實現的時候必須同步修改接口文檔，而文檔與代碼可能存儲於兩個不一樣的媒介，除非有嚴格的管理機制，不然易致使不一致現象。後端

　　三、溝通成本高：文檔更新時，若不能及時交流，前端不能及時獲取最新的接口信息。api

　　四、接口返回結果不明確，不能直接在線測試，一般需使用另外的工具，如：postman等。安全

做用：springboot

　　一、接口的文檔在線自動生成。服務器

　　二、功能測試。

Swagger2經常使用註解有哪些？

　　swagger經過註解代表該接口會生成文檔，包括接口名、請求方法、參數、返回信息的等等。

@Api：修飾整個類，描述Controller的做用
@ApiOperation：描述一個類的一個方法，或者說一個接口
@ApiParam：單個參數描述
@ApiModel：用對象來接收參數
@ApiProperty：用對象接收參數時，描述對象的一個字段
@ApiResponse：HTTP響應其中1個描述
@ApiResponses：HTTP響應總體描述
@ApiIgnore：使用該註解忽略這個API
@ApiError ：發生錯誤返回的信息
@ApiImplicitParam：一個請求參數
@ApiImplicitParams：多個請求參數

如何使用？（SpringBoot集成）

　　1)添加Maven依賴

<!--swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.8.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.8.0</version>
</dependency>

　　2）建立配置類，並添加註解 @Configuration和定義Docket的bean類

　　　　注意：在與spring boot 集成時，放在與application.java 同級的目錄下

　　　　　　經過@Configuration註解，讓spring來加載該配置

　　　　　　用@Configuration註解該類，等價於XML中配置beans；用@Bean標註方法等價於XML中配置bean。

　　　　　　再經過@EnableSwagger2註解來啓動Swagger2

@Configuration
public class Swagger2Config {
 
    //是否開啓swagger，正式環境通常是須要關閉的，可根據springboot的多環境配置進行設置
    @Value(value = "${swagger.enabled}")
    Boolean swaggerEnabled;
 
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
                // 是否開啓
                .enable(swaggerEnabled).select()
                // 掃描的路徑包
                .apis(RequestHandlerSelectors.basePackage("com.jack.springboot.controller"))
                // 指定路徑處理PathSelectors.any()表明全部的路徑
                .paths(PathSelectors.any()).build().pathMapping("/");
    }
 
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("SpringBoot-Swagger2示例")
                .description("jacking0325")
                // 做者信息
                .contact(new Contact("jacking0325", "https://blog.jack0325.cn/", "111111111@qq.com"))
                .version("1.0.0")
                .build();
    }
}

　　3）Application.class 加上註解@EnableSwagger2 表示開啓Swagger

@SpringBootApplication
@EnableSwagger2
public class SpringbootSwagger2Application {

	public static void main(String[] args) {
		SpringApplication.run(SpringbootSwagger2Application.class, args);
	}
}

　　4）RESTful接口（基礎打好，開始在代碼中使用）

@RestController
public class UserController {

	// 建立線程安全的Map
	static Map<Integer, User> users = Collections.synchronizedMap(new HashMap<Integer, User>());

	/**
	 * 根據ID查詢用戶
	 * @param id
	 * @return
	 */
	@ApiOperation(value="獲取用戶詳細信息", notes="根據url的id來獲取用戶詳細信息")
	@ApiImplicitParam(name = "id", value = "用戶ID", required = true, dataType = "Integer", paramType = "path")
	@RequestMapping(value = "user/{id}", method = RequestMethod.GET)
	public ResponseEntity<JsonResult> getUserById (@PathVariable(value = "id") Integer id){
		JsonResult r = new JsonResult();
		try {
			User user = users.get(id);
			r.setResult(user);
			r.setStatus("ok");
		} catch (Exception e) {
			r.setResult(e.getClass().getName() + ":" + e.getMessage());
			r.setStatus("error");
			e.printStackTrace();
		}
		return ResponseEntity.ok(r);
	}

	/**
	 * 查詢用戶列表
	 * @return
	 */
	@ApiOperation(value="獲取用戶列表", notes="獲取用戶列表")
	@RequestMapping(value = "users", method = RequestMethod.GET)
	public ResponseEntity<JsonResult> getUserList (){
		JsonResult r = new JsonResult();
		try {
			List<User> userList = new ArrayList<User>(users.values());
			r.setResult(userList);
			r.setStatus("ok");
		} catch (Exception e) {
			r.setResult(e.getClass().getName() + ":" + e.getMessage());
			r.setStatus("error");
			e.printStackTrace();
		}
		return ResponseEntity.ok(r);
	}

	/**
	 * 添加用戶
	 * @param user
	 * @return
	 */
	@ApiOperation(value="建立用戶", notes="根據User對象建立用戶")
	@ApiImplicitParam(name = "user", value = "用戶詳細實體user", required = true, dataType = "User")
	@RequestMapping(value = "user", method = RequestMethod.POST)
	public ResponseEntity<JsonResult> add (@RequestBody User user){
		JsonResult r = new JsonResult();
		try {
			users.put(user.getId(), user);
			r.setResult(user.getId());
			r.setStatus("ok");
		} catch (Exception e) {
			r.setResult(e.getClass().getName() + ":" + e.getMessage());
			r.setStatus("error");

			e.printStackTrace();
		}
		return ResponseEntity.ok(r);
	}

	/**
	 * 根據id刪除用戶
	 * @param id
	 * @return
	 */
	@ApiOperation(value="刪除用戶", notes="根據url的id來指定刪除用戶")
	@ApiImplicitParam(name = "id", value = "用戶ID", required = true, dataType = "Long", paramType = "path")
	@RequestMapping(value = "user/{id}", method = RequestMethod.DELETE)
	public ResponseEntity<JsonResult> delete (@PathVariable(value = "id") Integer id){
		JsonResult r = new JsonResult();
		try {
			users.remove(id);
			r.setResult(id);
			r.setStatus("ok");
		} catch (Exception e) {
			r.setResult(e.getClass().getName() + ":" + e.getMessage());
			r.setStatus("error");

			e.printStackTrace();
		}
		return ResponseEntity.ok(r);
	}

	/**
	 * 根據id修改用戶信息
	 * @param user
	 * @return
	 */
	@ApiOperation(value="更新信息", notes="根據url的id來指定更新用戶信息")
	@ApiImplicitParams({
			@ApiImplicitParam(name = "id", value = "用戶ID", required = true, dataType = "Long",paramType = "path"),
			@ApiImplicitParam(name = "user", value = "用戶實體user", required = true, dataType = "User")
	})
	@RequestMapping(value = "user/{id}", method = RequestMethod.PUT)
	public ResponseEntity<JsonResult> update (@PathVariable("id") Integer id, @RequestBody User user){
		JsonResult r = new JsonResult();
		try {
			User u = users.get(id);
			u.setUsername(user.getUsername());
			u.setAge(user.getAge());
			users.put(id, u);
			r.setResult(u);
			r.setStatus("ok");
		} catch (Exception e) {
			r.setResult(e.getClass().getName() + ":" + e.getMessage());
			r.setStatus("error");

			e.printStackTrace();
		}
		return ResponseEntity.ok(r);
	}

	@ApiIgnore//使用該註解忽略這個API
	@RequestMapping(value = "/hi", method = RequestMethod.GET)
	public String  jsonTest() {
		return " hi you!";
	}
}

　　5）Json格式輸出類 JsonResult.class

public class JsonResult {

	private String status = null;

	private Object result = null;

	// Getter Setter
}

　　6）Swagger訪問與使用

　　　　啓動springBoot項目，訪問api首頁路徑：http://localhost:8080/swagger-ui.html

　　　　建議在生產環境關閉Swagger2！

@RestControllerpublic class UserController { // 建立線程安全的Map static Map<Integer, User> users = Collections.synchronizedMap(new HashMap<Integer, User>()); /** * 根據ID查詢用戶 * @param id * @return */ @ApiOperation(value="獲取用戶詳細信息", notes="根據url的id來獲取用戶詳細信息") @ApiImplicitParam(name = "id", value = "用戶ID", required = true, dataType = "Integer", paramType = "path") @RequestMapping(value = "user/{id}", method = RequestMethod.GET) public ResponseEntity<JsonResult> getUserById (@PathVariable(value = "id") Integer id){ JsonResult r = new JsonResult(); try { User user = users.get(id); r.setResult(user); r.setStatus("ok"); } catch (Exception e) { r.setResult(e.getClass().getName() + ":" + e.getMessage()); r.setStatus("error"); e.printStackTrace(); } return ResponseEntity.ok(r); } /** * 查詢用戶列表 * @return */ @ApiOperation(value="獲取用戶列表", notes="獲取用戶列表") @RequestMapping(value = "users", method = RequestMethod.GET) public ResponseEntity<JsonResult> getUserList (){ JsonResult r = new JsonResult(); try { List<User> userList = new ArrayList<User>(users.values()); r.setResult(userList); r.setStatus("ok"); } catch (Exception e) { r.setResult(e.getClass().getName() + ":" + e.getMessage()); r.setStatus("error"); e.printStackTrace(); } return ResponseEntity.ok(r); } /** * 添加用戶 * @param user * @return */ @ApiOperation(value="建立用戶", notes="根據User對象建立用戶") @ApiImplicitParam(name = "user", value = "用戶詳細實體user", required = true, dataType = "User") @RequestMapping(value = "user", method = RequestMethod.POST) public ResponseEntity<JsonResult> add (@RequestBody User user){ JsonResult r = new JsonResult(); try { users.put(user.getId(), user); r.setResult(user.getId()); r.setStatus("ok"); } catch (Exception e) { r.setResult(e.getClass().getName() + ":" + e.getMessage()); r.setStatus("error"); e.printStackTrace(); } return ResponseEntity.ok(r); } /** * 根據id刪除用戶 * @param id * @return */ @ApiOperation(value="刪除用戶", notes="根據url的id來指定刪除用戶") @ApiImplicitParam(name = "id", value = "用戶ID", required = true, dataType = "Long", paramType = "path") @RequestMapping(value = "user/{id}", method = RequestMethod.DELETE) public ResponseEntity<JsonResult> delete (@PathVariable(value = "id") Integer id){ JsonResult r = new JsonResult(); try { users.remove(id); r.setResult(id); r.setStatus("ok"); } catch (Exception e) { r.setResult(e.getClass().getName() + ":" + e.getMessage()); r.setStatus("error"); e.printStackTrace(); } return ResponseEntity.ok(r); } /** * 根據id修改用戶信息 * @param user * @return */ @ApiOperation(value="更新信息", notes="根據url的id來指定更新用戶信息") @ApiImplicitParams({ @ApiImplicitParam(name = "id", value = "用戶ID", required = true, dataType = "Long",paramType = "path"), @ApiImplicitParam(name = "user", value = "用戶實體user", required = true, dataType = "User") }) @RequestMapping(value = "user/{id}", method = RequestMethod.PUT) public ResponseEntity<JsonResult> update (@PathVariable("id") Integer id, @RequestBody User user){ JsonResult r = new JsonResult(); try { User u = users.get(id); u.setUsername(user.getUsername()); u.setAge(user.getAge()); users.put(id, u); r.setResult(u); r.setStatus("ok"); } catch (Exception e) { r.setResult(e.getClass().getName() + ":" + e.getMessage()); r.setStatus("error"); e.printStackTrace(); } return ResponseEntity.ok(r); } @ApiIgnore//使用該註解忽略這個API @RequestMapping(value = "/hi", method = RequestMethod.GET) public String jsonTest() { return " hi you!"; } }

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。