hulang/think-api-doc

ThinkPHP 8.0.0+ API 接口文档生成工具

1.0.4 2024-06-18 08:40 UTC

Requires

• php: >=8.0.0
• topthink/framework: ^8.0.0

Apache-2.0

• hulang

• apidoc
• thinkphp
• api文档
• 自动生成
• thinkphp8

README

ThinkPHP 8.0.0+ API 接口文档生成工具

使用方法

1.安装扩展

composer require hulang/think-api-doc

2.配置参数

• 安装好扩展后在 config\apidoc.php 配置文件
• 需要指定layui目录
• 如路由css和图片未生效,请复制assets文件夹到你的静态(static)路径中,再配置文件config\apidoc.php配置static_assets参数进行指定目录

3.书写规范

<?php

namespace app\api\controller;

/**
 * @title API接口
 */
class Index
{
    /**
     * @title 首页信息
     * @desc 方法描述
     * @author 橘子味的心
     * @version 1.0
     * @method POST
     * @param int id ID YES
     * @param int limit 10 总条数 YES
     * @param int page 1 当前页 YES
     * @param int key 查询条件 NO
     * @return int code 200/100 返回参数
     * @return string msg ok 返回信息
     * @return array data 返回数据
     * @return array other 返回数据
     */
    public function index()
    {
    }
    /**
     * @title 用户信息
     * @desc 方法描述
     * @author 橘子味的心
     * @version 1.0
     * @method POST
     * @param int id ID YES
     * @param int limit 10 总条数 YES
     * @param int page 1 当前页 YES
     * @param int key 查询条件 NO
     * @return int code 200/100 返回参数
     * @return string msg ok 返回信息
     * @return array data 返回数据
     * @return array other 返回数据
     */
    public function user()
    {
    }
}

4.访问方法

• http://你的域名/apidoc
• http://你的域名/index.php/apidoc