当前位置：首页 > article >正文

thinkphp8.0 likeadmin 框架添加API 文档自动生成工具 apidoc支持

article 2025/1/19 4:09:38

Apidoc 是一个便捷的 API 文档自动生成工具，它能帮助开发者快速生成和管理 API 文档。以下是 Apidoc 的主要特点和功能：

主要特点

开箱即用
- 安装后，无需繁杂配置，直接按照文档编写注释，即可自动生成 API 文档。
轻松编写
- 支持通用注释引用、业务逻辑层及数据表字段的引用。几句简单的注释即可完成文档的生成，提升开发效率。
在线调试
- 在线生成的文档不仅可以查看接口信息，还支持直接调试接口，能够方便地模拟请求，快速测试接口功能，支持全局请求参数、Mock 参数和事件处理，节省调试时间。
安全高效
- 支持访问密码验证，可以为文档添加应用/版本独立密码，确保文档的安全性。此外，Apidoc 还支持文档缓存，有效提高访问速度。
多应用/多版本
- 支持多应用、多版本的 API 管理，能够适应不同规模的项目，无论是单一应用还是复杂的多应用、多版本系统。
分组/Tag
- 可以对控制器和接口进行多级分组，或使用 Tag 来组织和分类接口，提升文档的可读性和结构性。
Markdown文档支持
- 支持 .md 格式文件的展示，方便开发者将文档输出为 Markdown 格式，便于团队分享和协作。
接口生成器
- 提供配置和模板功能，能够快速生成代码及数据表结构，大大提高工作效率，减少手动编写代码的工作量。
Json/TypeScript 生成
- 自动生成接口的 JSON 和 TypeScript 文件，帮助前端开发人员快速获取接口定义，减少沟通成本。

使用场景

API 文档自动生成：适用于需要自动化管理 API 文档的开发团队，尤其是在多团队、多模块的项目中，可以大幅提高 API 文档的管理和维护效率。
接口调试和测试：方便开发人员调试 API 接口，模拟请求和响应，快速发现并修复问题。
项目文档整合：支持 Markdown 格式的文档输出，可以方便地整合项目文档，便于团队内部或外部的知识共享。

适用环境

Apidoc 适用于大多数使用 RESTful API 或 GraphQL API 的项目，可以轻松与现有的 Web 框架（如 Node.js, Express, Django, Flask, Laravel 等）集成。

安装教程: 请严格参考官方教程来

thinkphp 安装

ThinkPHP 安装 | Apidoc

如果遇到问题请参考:

500错误 | Apidoc

实在不行, 加入官方群聊解决哦

以下是安装 Apidoc 插件的详细步骤：

1. 安装插件

在项目的根目录下，通过 Composer 安装 Apidoc 插件。执行以下命令：

composer require hg/apidoc

2. 配置 `apps`

安装完成后，你需要根据你的项目结构调整 apps 配置文件。打开项目中的配置文件 config/apidoc.php，然后根据你的实际情况修改配置：

'apps' => [
    [
        'title' => 'Api接口',  // 文档标题
        // 核对配置文件中的此目录是否正确
        'path' => 'app\controller',  // 这里是你的控制器文件夹路径
        'key' => 'api',  // API 的唯一标识
    ]
],

确保配置中的路径 path 指向你的控制器目录，并根据需要调整其他参数。

3. 添加前端页面

从 Gitee 下载： 如果你选择从 Gitee 下载前端页面，可以在 Gitee 上找到 Apidoc 的前端页面代码，并将其下载到本地。
从 Github 下载： 同样地，你也可以从 Github 下载 Apidoc 前端页面代码，网址通常是 https://github.com/HGthecode/apidoc-php，然后将前端代码下载到本地。

下载完成后，解压缩文件，并将 apidoc 文件夹拷贝到项目的 public 目录下。