摘要:一個(gè)簡(jiǎn)單的輸出工具,只需簡(jiǎn)單配置,即可將接口中的所有接口及參數(shù)全部以結(jié)構(gòu)化的方式輸出的頁(yè)面上。新增支持文件類型的數(shù)據(jù)。優(yōu)化了返回結(jié)果格式化的問題。改版了界面列表展示部分,修復(fù)了掃描不到的情況。增加了對(duì)的支持支持上傳文件。
spring.boot.sapi.starter
一個(gè)簡(jiǎn)單的API輸出工具,只需簡(jiǎn)單配置,即可將接口中的所有API接口及參數(shù)全部以結(jié)構(gòu)化的方式輸出的頁(yè)面上。
基于SpringMvc或Springboot的接口管理工具
1.下載并打包Jar配置好POM
com.github.xiaour xiaour.springboot.sapi.starter 1.4
2.啟動(dòng)類加入注解@Sapi.
controllers屬性可以聲明多個(gè),如controllers = {"com.example.demo.ctrl","com.example.demo2.ctrl"},controllers的路徑對(duì)應(yīng)項(xiàng)目中controller所在的路徑。enable是SAPI的開關(guān),如果需要上生產(chǎn)環(huán)境只需要enable=false就可以了,這樣避免在生產(chǎn)暴露接口。
@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是用于分組輸出的注解,可以在上面加入中文接口注釋,該注解可有可無,如不注解,默認(rèn)輸出的是當(dāng)前類名。
@SapiGroup(title = "小貓管理") @RestController @RequestMapping("/cat") public class CatController { }
4.項(xiàng)目啟動(dòng)后會(huì)在控制臺(tái)輸出一條SAPI的URL,打開就可以看到相關(guān)的API了,下面是一個(gè)打開后的演示界面??炜鞙y(cè)試你的API吧!
目前項(xiàng)目在Github和碼云都有開源,歡迎Star或fork
https://github.com/xiaour/spr...
https://gitee.com/xiaour/spri...
當(dāng)前為1.4版本,實(shí)現(xiàn)了輸出接口URL和參數(shù),分組輸出接口;
2.0版本將實(shí)現(xiàn)添加接口說明、歷史版本接口管理更新日志
20180621.頁(yè)面上提供了POST和GET測(cè)試。
20180628.新增支持文件類型的數(shù)據(jù)。
20180702.新增支持自定義請(qǐng)求Header。
20180710.新增了接口分頁(yè)。
20180828.優(yōu)化了返回結(jié)果格式化的問題。
20180907.改版了界面列表展示部分,修復(fù)了Class掃描不到的情況。
20180912.增加了對(duì)RequestBody的支持,支持MultipartFile上傳文件。
文章版權(quán)歸作者所有,未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為,您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請(qǐng)注明本文地址:http://systransis.cn/yun/77113.html
摘要:是一個(gè)及其精簡(jiǎn)的輸出工具,誕生的背景是基于目前微服務(wù)開發(fā)接口,很多中小型項(xiàng)目開發(fā)人員在對(duì)接口測(cè)試時(shí)不僅需要使用等進(jìn)行業(yè)務(wù)接口測(cè)試,還需要對(duì)進(jìn)行自測(cè)。目前只需要開發(fā)人員引入后再啟動(dòng)類加入一行文件即可。中的路徑不要忽略。 SAPI是一個(gè)及其精簡(jiǎn)的Restful API輸出工具,誕生的背景是基于目前微服務(wù)開發(fā)接口,很多中小型項(xiàng)目開發(fā)人員在對(duì)接口測(cè)試時(shí)不僅需要使用JUnit等進(jìn)行業(yè)務(wù)接口測(cè)試,...
摘要:因此,我們需要性能優(yōu)異的引擎合適的車輪正確的跑道三架構(gòu)從下往上四層屬于操作系統(tǒng)的底層服務(wù)器,屬于次服務(wù)器,溝通和屬于服務(wù)端編程語言,通過模塊和關(guān)聯(lián)和其他服務(wù)屬于應(yīng)用服務(wù),通過的外掛模塊和關(guān)聯(lián)參考文檔底層工作原理 一、簡(jiǎn)介 PHP總共有三個(gè)模塊:內(nèi)核、Zend引擎、以及擴(kuò)展層 PHP內(nèi)核用來處理請(qǐng)求、文件流、錯(cuò)誤處理等相關(guān)操作 Zend引擎(ZE)用以將源文件轉(zhuǎn)換成機(jī)器語言,然后在虛擬...
摘要:刪除后指定產(chǎn)品不存在獲取商品列表未分頁(yè)獲取全部商品成功系列的表殼材料為輕巧的銀色及深空灰色陽極氧化鋁金屬,強(qiáng)化玻璃材質(zhì)為顯示屏提供保護(hù)。外觀設(shè)計(jì)不再棱角分明,表層玻璃邊有一個(gè)弧度向下延伸,與陽極氧化鋁金屬機(jī)身邊框銜接。 背景 API 就是開發(fā)者使用的界面。我的目標(biāo)不僅是能用,而且好用,跨平臺(tái)(PC, Android, IOS, etc...)使用。本文將詳細(xì)介紹 API 的設(shè)計(jì)及異常處...
摘要:刪除后指定產(chǎn)品不存在獲取商品列表未分頁(yè)獲取全部商品成功系列的表殼材料為輕巧的銀色及深空灰色陽極氧化鋁金屬,強(qiáng)化玻璃材質(zhì)為顯示屏提供保護(hù)。外觀設(shè)計(jì)不再棱角分明,表層玻璃邊有一個(gè)弧度向下延伸,與陽極氧化鋁金屬機(jī)身邊框銜接。 背景 API 就是開發(fā)者使用的界面。我的目標(biāo)不僅是能用,而且好用,跨平臺(tái)(PC, Android, IOS, etc...)使用。本文將詳細(xì)介紹 API 的設(shè)計(jì)及異常處...
閱讀 1878·2023-04-26 01:58
閱讀 1997·2019-08-30 11:26
閱讀 2739·2019-08-29 12:51
閱讀 3507·2019-08-29 11:11
閱讀 1193·2019-08-26 11:54
閱讀 2109·2019-08-26 11:48
閱讀 3492·2019-08-26 10:23
閱讀 2394·2019-08-23 18:30