[新包釋出] 基於註釋的 API 文件與 測試工具 [從此不再寫該死的文件]

KEL發表於2017-09-22

輕量級laravel REST文件與介面測試工具 用於檢視和測試後端REST介面

分享一個團隊內部用了很久的API文件包。
我們的開發團隊是典型的精小團隊,人員總共在10人左右,用什麼樣的API文件一直是困擾團隊開發效率的一個問題。作為一個敏捷開發的團隊是絕對不會去碰word文件的,太low了。然後也用過一些生成文件的工具,比如apigen,但是要寫很冗長的註釋,返回格式啥的整個註釋塊都比控制器的程式碼多,看得很不舒服,而且每次更改後還需要編譯,很麻煩。也用過第三方的介面文件,但是每次修改完介面後還要去那邊修改介面文件,也就比word好那邊一點吧,總之也很麻煩。
所以自己做了個基於Laravel的Route的API文件,實現方式簡單說就是透過路由獲取到所有的API介面,然後透過API介面中定義的控制和方法名反射獲取到方法對應的註釋,稍微解析一下,然後輸出到網頁上,隨便做了個簡單的直接呼叫介面的方式,類似POSTMAN(當然沒它高階)。有興趣的朋友可以看下提提意見。

詳細使用方法請檢視github[https://github.com/deathkel/apitest]

介面展示

本作品採用《CC 協議》,轉載必須註明作者和本文連結

相關文章