好用的API介面文件推薦總結
我是做服務端開發的,經常需要些介面文件,以前用過txt,word,感覺體驗太差了。
網上找過很多,下面給大家總結一下。
易文件
應該是我用過體驗最好的線上介面文件,專門優化過的http文件編輯和預覽頁面,編寫很方便,預覽很漂亮,還支援線上介面除錯。另外還有一些很方便的小功能,感覺用了就回不去了。
Showdoc
這個只支援markdown格式的文件,編寫起來比較麻煩,不過好在還有一個文件模板,不然真的就跟寫txt,word差不多的體驗了。預覽頁面感覺還不夠美觀。
小么雞
這個算是上線比較早的了,以前也用它寫過介面文件,但是介面實在是太普通了,感覺還是10幾年前那種設計,可能是因為個人專案,所以沒怎麼注重設計。每次編寫完一行引數,得滑鼠去點選下才能建立下一行引數,不夠暢快,後面拋棄了。
gitbook
挺好的,國外人做的東西感覺很專業,但就是網速讓人無奈,沒法用。
Rap
據傳是阿里團隊出的,還有第二代叫RAP2,功能還不錯,不過引數行無法拖動選擇文字,會變成拖動。
apizza
一直不知道怎個怎麼讀,感覺很拗口。他的設計很像postman,本來我挺喜歡這個的,感覺挺專業,但是竟然沒有響應文件,真是搞不懂,為什麼會沒有響應文件。
相關推薦
好用的API介面文件推薦總結
我是做服務端開發的,經常需要些介面文件,以前用過txt,word,感覺體驗太差了。網上找過很多,下面給大家總結一下。 易文件應該是我用過體驗最好的線上介面文件,專門優化過的http文件編輯和預覽頁面,編寫很方便,預覽很漂亮,還支援線上介面除錯。另外還有一些很方便的小功能,感覺用了就回不去了。 Showdo
推薦一個很好用的 Markdown 文件編輯器
在使用 Markdown 寫文件之前,一直都是用 Latex 的。但是無論是 Texlive 還是 windows 下的 ctex 都搞的越來越大,想要看效果還要編譯一下,很不方便。所以知道了有 Markdown 之後就果斷的轉到 Markdown了。 用
java非常好用的讀取文件的流的代碼
write 技術 output 空白 leo struts puts inf 不知道 學過java的都知道java中有非常多的讀取文件流的操作。這個要回到javase的io操作了。io流說實話,初學者學的肯定會非常混亂,那麽多流,什麽輸入流,輸出流,什麽文件流,什麽字節流,
Swagger2整合springBoot,自動生成API介面文件
Swagger2整合springBoot 首先匯入jar包 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swa
Swagger 生成 PHP API 介面文件
Swagger 生成 PHP API 介面文件 標籤(空格分隔): php 1、概況 有同學反饋寫幾十個介面文件需要兩天的工作量, 隨著多部門之間的協作越來越頻繁, 維護成本越來越高, 文件的可維護性越來越差, 需要一個工具來管理這些介面的文件, 並能夠充當mock server給呼叫方使用。 有
整合swagger2生成Restful Api介面文件 webapi文件描述-swagger
整合swagger2生成Restful Api介面文件 swagger Restful文件生成工具 2017-9-30 官方地址:https://swagger.io/docs/specification/about/ 官方Github:https://github.com/swagger-
API介面文件說明
API文件規範要求 一、 寫明該介面的功能是什麼 二、 請求的URL是什麼 三、 請求方式是什麼(POST、GET、 DELETE、PUT、 PATCH等) 四、 引數是什麼,此處還需說明你的引數名、引數型別、是否必填、引數的簡單解釋 五、 請求成功時的響應內容(實際開發中,要與前端同事溝通
Swagger2 快速定義API介面文件
引入依賴 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.7.0&
Spring專案整合apidoc生成api介面文件
一、背景需求 JavaWeb/spring專案寫成的api介面,需要自動生成api文件,甚至需要線上測試介面。考慮實現的方案有swagger,apidoc,spring rest docs。在之後的專案都有一一嘗試,最終還是覺得apidoc的方式比較合適,雖然有一些問題(針對線上
swagger 生成 PHP restful API 介面文件
需求: 為客戶端同事寫介面文件的各位後端同學,已經在各種場合回憶了使用自動化文件工具前手寫文件的血淚史. 我的故事卻又不同,因為首先來說,我在公司是 Android 組負責人,屬於上述血淚史中催死人不償命的客戶端陣營. 但血淚史卻是相通的,沒有自動化文件的日子,對介面
如何優雅的“編寫”api介面文件
前言 今天我需要把之前寫的介面整理成文件,老大給了意見用swagger搞,我像發現新大陸一樣的興奮,迫不及待得去“佔有”它。 Swagger很容易上手,我花了十幾分鍾就搞定了。正好接著之前的如何優雅的格式化介面,這裡再說一下SpringBoot整合Swagger的簡單過
Spring Cloud Zuul中使用Swagger彙總API介面文件
有很多讀者問過這樣的一個問題:雖然使用Swagger可以為Spring MVC編寫的介面生成了A
bigemap百度離線地圖API介面文件及介面呼叫例項
1.當前版本支援百度電子地圖瓦片和百度衛星地圖瓦片; 2.效果預覽演示地址:http://www.bigemap.com/bmap 後臺編輯體驗地址:http://www.bigemap.com/bmap/ 可隨意在後臺新增/修改標註
.NET Core使用swagger進行API介面文件管理
一、問題背景 隨著技術的發展,現在的開發模式已經更多的轉向了前後端分離的模式,在前後端開發的過程中,聯絡的方式也變成了API介面,但是目前專案中對於API的管理很多時候還是通過手工編寫文件,每次的需求變更只要涉及到介面的變更,文件都需要進行額外的維護,如果有哪個小夥伴忘記維護,很多時候就會造
【流程規範】API介面文件規範
介面名稱 前置主動還款申請(/payBill) 介面描述 返回格式:json 請求方式:GET/ POST 介面備註:根據傳入的key和qq號碼發起還款的申請 請
swagger-ui教程 構建api介面文件工具
1.在我第一次開發app後端的時候,使用的word文件,就是我先將所有資料格式定義好,會返回什麼樣的資料寫好。前端人員照這個來進行開發。貼一張圖吧: PS:存在的問題:①介面改動時,不易被識別。②維護困難,不便於查詢。③前端開發不能進行測試。(如果還要寫
一個好用的大文件傳輸工具:支持選點續傳、錯誤重傳
文件 重傳機制 中間 數據流 ans 導致 自動 目前 strong 數據正在爆炸式增長,幾乎每兩年翻一番。這些數據和文件可能是組織機構重要的業務數據,也可能是其重要的信息資源。 通常情況下,組織機構使用郵件、QQ、FTP等常規方式傳輸文件,但是當文件容量在2-3G以上時,
Swagger UI教程 API 文件神器 搭配Node使用 web api 介面文件 mvc介面文件
兩種方案 一、Swagger 配置 web Api 介面文件美化 二、通過NodeJS 釋出Swagger UI 配置api 文件 先說一下簡單的 Swagger 配置 web Api Swagger-UI本身只提供線上測試功能,要整合它還需要告訴它本專案提供的各
谷歌離線地圖API介面文件及介面呼叫例項
相關教程:說明:1. 當前版本支援 谷歌電子/衛星地圖瓦片、高德地圖、阿里雲地圖、超圖、騰訊地圖等(只需下載該地圖源的瓦片拷貝到指定目錄即可);(只下載了部分谷歌地圖瓦片作為離線樣本,某些地方無法顯示視為正常,包含全國4-12級,部分成都13-16級)3. 我們可以提供離線
API介面文件生成方案調研
1調研背景目前存在以下情況:1)一般開發人員更新介面後,沒有同時更新rap,rap上的介面定義普遍存在跟程式碼不一致的情況。2)後端開發人員檢視別人介面,很難很快地知道介面的作用,以及介面入參和返回結果中每個欄位的含義。3)rap上的mock資料功能不是特別好用。2 調研結果