一個簡單的API輸出工具,只需簡單配置,便可將接口中的全部API接口及參數所有以結構化的方式輸出的頁面上。
基於SpringMvc或Springboot的接口管理工具java
1.下載並打包Jar配置好POMgit
<dependency> <groupId>com.github.xiaour</groupId> <artifactId>xiaour.springboot.sapi.starter</artifactId> <version>1.4</version> </dependency>
2.啓動類加入註解@Sapi.
controllers屬性能夠聲明多個,如controllers = {"com.example.demo.ctrl","com.example.demo2.ctrl"},controllers的路徑對應項目中controller所在的路徑。enable是SAPI的開關,若是須要上生產環境只須要enable=false就能夠了,這樣避免在生產暴露接口。github
@Sapi(controllers = {"com.example.demo.ctrl"}) @SpringBootApplication public class DemoApplication { public static void main(String[] args) { SpringApplication.run(DemoApplication.class, args); } }
3.Controller類加入註解@SapiGroup(title="").
SapiGroup是用於分組輸出的註解,能夠在上面加入中文接口註釋,該註解無關緊要,如不註解,默認輸出的是當前類名。spring
@SapiGroup(title = "小貓管理") @RestController @RequestMapping("/cat") public class CatController { }
4.項目啓動後會在控制檯輸出一條SAPI的URL,打開就能夠看到相關的API了,下面是一個打開後的演示界面。快快測試你的API吧!api
目前項目在Github和碼雲都有開源,歡迎Star或fork
https://github.com/xiaour/spr...
https://gitee.com/xiaour/spri...springboot
當前爲1.4版本,實現了輸出接口URL和參數,分組輸出接口;app
更新日誌工具
20180621.頁面上提供了POST和GET測試。測試
20180628.新增支持文件類型的數據。優化
20180702.新增支持自定義請求Header。
20180710.新增了接口分頁。
20180828.優化了返回結果格式化的問題。
20180907.改版了界面列表展現部分,修復了Class掃描不到的狀況。
20180912.增長了對RequestBody的支持,支持MultipartFile上傳文件。