前言:
最近工作中需求,需要利用mybatis-plus代碼生成器生成的做成一個接口文檔給客戶,我找了很多資料,都是亂七八糟的看不懂,我自己從頭到尾做了一遍,分享出來,如果有誤,請指點
一、Swagger在線文檔的生成
- 創建一個springboot項目(不做演示),導包
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
- 在主啓動類同級目錄下創建config包,創建SwaggerConfig類
- 啓動項目,訪問localhost:8080/swagger-ui.html (注意端口)
二、生成word接口文檔
- 下載這個項目,用來生成文檔的
百度鏈接:https://pan.baidu.com/s/1b8JnD82–8hmeejM_MS9cA
提取碼:qmm2 - 下載完成後打開項目,可以直接運行的,先訪問一下,返回hello Swagger2word!即成功!
- 運行我們需要導出接口文檔的服務,http://localhost:8121/v2/api-docs我的是這樣,後面的/v2/api-docs解釋如下圖:
- 我們把這個地址複製到生成項目的配置文件裏
- 重新啓動項目,訪問locaohost:8080/toWord
- 下載文檔,即可成功