編寫和維護API文檔這個事情,對於后端程序員來說,是一件惱人但又不得不做的事情,我們都不喜歡寫文檔,但除非項目前后端代碼都是自己寫的,否則API文檔將是前后端協作中一個不可或缺的溝通界面。既然不可避免,那就想辦法弄個輪子吧。人生苦短,必須偷懶。無圖無真相,生成文檔的效果如下:
相比Swagger要寫一堆注解,Spring RestDocs需要寫測試用例,才能生成API文檔。Eolinker 具有無痛集成的特點,你只需花幾分鍾就能知道它怎么用了。
快速開始
產品支持幾種創建API文檔的方式:
1.手動創建文檔:適合所有團隊;
2.根據代碼注解自動生成文檔:適合使用過或正在使用Swagger產品來自動生成文檔的團隊。
3.根據代碼模板快速創建API文檔:適合所有團隊。
接下來你只管好好寫代碼,生成Api文檔的工作就可以交給Eolinker了,你不需要再為額外編寫和維護文檔而煩惱。
功能特性
1、代碼即文檔 只要語法符合一定的代碼規范,有合理的注釋,就可以直接導出文檔。
2、支持導出HTML便捷的導航和接口查看界面;可本地預覽,或者部署到HTTP服務器。推薦部署到服務器,方便前后端展開協作。
3、更多特性支持接口搜索、支持不同版本、自定義擴展等。
簡潔的文檔
再好用的東西,如果沒有文檔說明,別人也無從入手。為了讓大家盡快上手,Eolinker准備了一份極簡的文檔說明,確保你在幾分鍾就能用上Eolinker。花5分鍾不到就能認識一個提高工作效率的工具,讓你把更多的時間花在更加有價值的事情上,你確認不看一下嗎?
使用地址及幫助文檔:www.eolinker.com