建站
咨詢
售后
建站咨詢
新聞中心
本文轉(zhuǎn)載自微信公眾號(hào)「Java極客技術(shù)」，作者鴨血粉絲。轉(zhuǎn)載本文請(qǐng)聯(lián)系Java極客技術(shù)公眾號(hào)。
創(chuàng)新互聯(lián)專(zhuān)注于呼和浩特網(wǎng)站建設(shè)服務(wù)及定制，我們擁有豐富的企業(yè)做網(wǎng)站經(jīng)驗(yàn)。 熱誠(chéng)為您提供呼和浩特營(yíng)銷(xiāo)型網(wǎng)站建設(shè)，呼和浩特網(wǎng)站制作、呼和浩特網(wǎng)頁(yè)設(shè)計(jì)、呼和浩特網(wǎng)站官網(wǎng)定制、微信小程序開(kāi)發(fā)服務(wù)，打造呼和浩特網(wǎng)絡(luò)公司原創(chuàng)品牌,更為您提供呼和浩特網(wǎng)站排名全網(wǎng)營(yíng)銷(xiāo)落地服務(wù)。
因?yàn)樽罱⒎垡恢痹谧鼋涌陂_(kāi)發(fā)，前后端分離的項(xiàng)目，阿粉在之前也看過(guò)關(guān)于swagger，但是阿粉沒(méi)有用，畢竟弄這個(gè)東西，還需要leader批示，加出問(wèn)題來(lái)了，還容易背鍋，于是阿粉就開(kāi)始找能夠快速生成接口文檔的工具，終于，阿粉成功找到了一個(gè)比postman還要好用的工具，即可以做接口的測(cè)試，還能生成接口文檔。
Run-Api
runapi是一個(gè)以接口為核心的開(kāi)發(fā)測(cè)試工具(功能上類(lèi)似一個(gè)簡(jiǎn)化版的postman)。目前有客戶端版(推薦，支持win和mac平臺(tái))和在線精簡(jiǎn)版 ，包含接口測(cè)試/項(xiàng)目協(xié)作等功能。
它和showdoc( https://www.showdoc.com.cn/help)相輔相成：showdoc以文檔為核心，側(cè)重文檔編寫(xiě)和知識(shí)資料沉淀。而runapi則以接口為核心，包含接口測(cè)試、管理等一系列功能。同時(shí)它將自動(dòng)生成文檔到showdoc。
Run-Api怎么用
首先我們先下載這個(gè)軟件，
官網(wǎng)，官方防止給大家放上了，大家可以去下載一下，我們現(xiàn)在就來(lái)看看他是怎么用的。
Run-Api接口測(cè)試
大家安裝完后就是這個(gè)樣子了，我們?cè)趺慈サ粲媒涌谀?
先創(chuàng)建個(gè)默認(rèn)的項(xiàng)目，然后給起一個(gè)比較酷炫的名字，
然后再這里選擇你想要把地址寫(xiě)在哪個(gè)項(xiàng)目中，
大家看，是不是和postman的測(cè)試是一樣的，況且，postman你還需要去找指定版本，有時(shí)候還會(huì)導(dǎo)致你系統(tǒng)卡死，但是因?yàn)槭枪J(rèn)的好用的，所以很多人都直接選擇使用postman，但是現(xiàn)在找到了更好的，大家是不是就可以開(kāi)始換一下了?
假如你們的項(xiàng)目有增加安全機(jī)制，那么在請(qǐng)求的Headers中肯定也加入了一些必須要給的參數(shù)，比如Token，如果你在每個(gè)接口里面都需要這個(gè)Token 的話，你還要給每個(gè)接口都加，那多麻煩，來(lái)配置個(gè)全局的參數(shù)變量吧，看下圖所示
大家進(jìn)入官網(wǎng)之后，忽然看到了個(gè)本地/局域網(wǎng)，這是個(gè)啥呢?
官網(wǎng)簡(jiǎn)介：如果你是使用runapi客戶端(https://www.showdoc.cc/runapi),則會(huì)自動(dòng)跨域，可以請(qǐng)求本地和局域網(wǎng)的接口，不需要用戶額外操作。但如果你是使用在線精簡(jiǎn)版( http://runapi.showdoc.cc )則需要在API的服務(wù)器上設(shè)置允許跨域。在服務(wù)器返回API結(jié)果的時(shí)候，也順便返回三個(gè)允許跨域的http header，其結(jié)構(gòu)如下：
- Access-Control-Allow-Origin: *
- Access-Control-Allow-Credentials : true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Connection, User-Agent, Cookie
大家注意看，如果你直接使用在線版本，那么你需要關(guān)心這個(gè)，如果你像阿粉一樣，直接使用客戶端，那么恭喜你，這一步，你可以壓根就不用管，因?yàn)楣倬W(wǎng)告訴我們了，他可以自己跨域，是不是很爽?
Run-Api如何生成接口文檔
我們把我們想要的信息都設(shè)置完成之后，然后點(diǎn)擊發(fā)送，等待結(jié)果出現(xiàn)，這時(shí)候我們就要點(diǎn)擊保存了。
保存完成之后，它會(huì)根據(jù)你設(shè)置的入?yún)⑦€有出參，給你生成文檔，
上圖是入?yún)ⅲ臋n圖在這里，來(lái)了
同時(shí)它會(huì)給你一個(gè)密碼，只有你們兩個(gè)人知道呦，這樣我們就打開(kāi)網(wǎng)址來(lái)看看，這個(gè)接口文檔是什么樣子的，有沒(méi)有大家想象中的那么簡(jiǎn)單易懂。
入?yún)?shí)例：
出參實(shí)例：
看是不是有點(diǎn)牛，而且樣子還是非常美觀的，也不需要去像Swagger一樣，去給方法里面加注解，而如果你對(duì)Swagger不是特別熟練，有時(shí)候還會(huì)忘記，但是這樣生成了，給前端的網(wǎng)址，然后讓他們自己去調(diào)用接口就可以了，是不是很爽，又安利了一款軟件。
如果大家需要，請(qǐng)?jiān)诠娞?hào)后臺(tái)回復(fù)runapi，連接地址發(fā)給大家，直接下載即可使用，你還在等什么呢?
對(duì)比postman
我們?cè)賮?lái)看看傳統(tǒng)的postman，英文比較多，
GET請(qǐng)求：點(diǎn)擊Params，輸入?yún)?shù)及value，可輸入多個(gè)，即時(shí)顯示在URL鏈接上， 所以，GET請(qǐng)求的請(qǐng)求頭與請(qǐng)求參數(shù)如在接口文檔中無(wú)特別聲明時(shí)，可以不填。
POST請(qǐng)求：傳遞參數(shù)params，Json格式的就行，然后再發(fā)送請(qǐng)求就可以，阿粉認(rèn)為，畢竟很多人都在用postman，但是哪個(gè)好用，哪個(gè)不好用，這個(gè)還是分人，就比如有人喜歡牛奶，有人喜歡可樂(lè)，有人喜歡果汁一樣。
所以，選擇什么軟件，大家就用什么軟件，沒(méi)有必要強(qiáng)求不是，到現(xiàn)在阿粉公司都是IDEA和Eclipse共存，使用習(xí)慣不一樣，就是不一樣，所以，大家看著選擇吧。
分享文章：一款比Postman還要好用的測(cè)試接口工具，竟然還能生成接口文檔？
當(dāng)前路徑：http://m.5511xx.com/article/cdpphhe.html
