Apidoc-phpAPI 接口文檔生成工具
Apidoc是一個(gè)通過(guò)解析注解生成 API 接口文檔的 PHP composer 擴(kuò)展，支持在線調(diào)試、Mock數(shù)據(jù)、Md文檔等功能。
全面的注解引用、數(shù)據(jù)表字段引用，簡(jiǎn)單的注解即可生成Api文檔，而Apidoc不僅于接口文檔，在線接口調(diào)試、Mock調(diào)試數(shù)據(jù)、調(diào)試事件處理、Json/TypeScript生成、批量測(cè)試、接口分享、代碼生成器、Api市場(chǎng)等諸多實(shí)用功能，致力于提高Api接口開(kāi)發(fā)效率。
特性
- 開(kāi)箱即用：無(wú)繁雜的配置、安裝后按文檔編寫(xiě)注釋即可自動(dòng)生成API文檔。
- 輕松編寫(xiě)：支持通用注釋引用、業(yè)務(wù)邏輯層、數(shù)據(jù)表字段的引用，幾句注釋即可完成。
- 在線調(diào)試：在線文檔可直接調(diào)試，并支持全局請(qǐng)求/Mock參數(shù)/事件處理，接口調(diào)試省時(shí)省力。
- 安全高效：支持訪問(wèn)密碼驗(yàn)證、應(yīng)用/版本獨(dú)立密碼；支持文檔緩存。
- 多應(yīng)用/多版本：可適應(yīng)各種單應(yīng)用、多應(yīng)用、多版本的項(xiàng)目的Api管理。
- 分組/Tag：可對(duì)控制器/接口進(jìn)行多級(jí)分組或定義Tag。
- Markdown文檔：支持.md文件的文檔展示。
- Json/TypeScript生成：文檔自動(dòng)生成接口的Json及TypeScript。
- 代碼生成器：配置+模板即可快速生成代碼及數(shù)據(jù)表的創(chuàng)建，大大提高工作效率。
兼容
以下框架已內(nèi)置兼容，可開(kāi)箱即用。其它框架可參考其它框架安裝說(shuō)明進(jìn)行手動(dòng)兼容。
| 框架 | 版本 | 說(shuō)明 |
|---|---|---|
| ThinkPHP | 5.1、6.x | |
| Laravel | 8.x、9.x | 其它版本未測(cè)試 |
| Hyperf | 2.x | 其它版本未測(cè)試 |
| Webman | 2.x | 需手動(dòng)配置兼容 |
評(píng)論
圖片
表情