ThinkPHP ApiDoc根據(jù)注釋自動(dòng)生成 API 接口文檔

ThinkPHP ApiDoc 是一款基于 ThinkPHP 根據(jù)注釋自動(dòng)生成 API 接口文檔的工具。

???♀? Apidoc是什么？

如今，前后端分離的開發(fā)模式以必不可少，基于ThinkPHP你可以很方便的作為后端Api的開發(fā)。可是一個(gè)Api開發(fā)過程中需要快速調(diào)試，開發(fā)完成后需要給其它開發(fā)者對(duì)接，這時(shí)一個(gè)詳細(xì)的Api文檔，就顯得特別重要。

大多數(shù)開發(fā)者可能都是通過各種工具配合來達(dá)到這一目的，其各種工具的安裝和配置也是繁瑣。甚至還有通過word等文本工具手寫api文檔的，這樣的開發(fā)效率與可維護(hù)性是非常差的。

綜合種種Api開發(fā)中的痛點(diǎn)，我們專為ThinkPHP開發(fā)了Apidoc的擴(kuò)展插件，本插件可通過簡(jiǎn)單的注解即可生成Api文檔，及幫助開發(fā)者提高生產(chǎn)效率的在線調(diào)試、快速生成Crud、一鍵生成整個(gè)模塊Api等，涵蓋Api開發(fā)方方面面。

?特性

• 開箱即用：無繁雜的配置、安裝后按文檔編寫注釋即可自動(dòng)生成API文檔。
• 在線調(diào)試：在線文檔可直接調(diào)試，支持設(shè)置全局參數(shù)，接口調(diào)試省時(shí)省力。
• 輕松編寫：支持公共注釋定義、業(yè)務(wù)邏輯層、數(shù)據(jù)表字段的引用，幾句注釋即可完成。
• 安全高效：訪問API文檔頁面需密碼驗(yàn)證；支持緩存接口數(shù)據(jù)，無需每次都生成數(shù)據(jù)。
• 多應(yīng)用/多版本：可適應(yīng)各種單應(yīng)用、多應(yīng)用、多版本的項(xiàng)目的Api管理。
• Markdown文檔：支持.md文件的文檔展示。
• 快速生成Crud：配置+模板即可快速生成Crud接口代碼及數(shù)據(jù)表的創(chuàng)建，大大提高工作效率。
• 控制器分組：更精細(xì)化的對(duì)控制器接口進(jìn)行分組展示。

??兼容

ThinkPHP 6.x

如需在 ThinkPHP 5.x 版本中使用，請(qǐng)安裝 V1.x版本 V1.x版本安裝說明

??使用文檔

ThinkPHP ApiDoc V2.x文檔

ThinkPHP ApiDoc V1.x文檔

??支持我們

如果本項(xiàng)目對(duì)您有所幫助，請(qǐng)點(diǎn)個(gè)Star支持我們

• Gitee -> 
• Github ->