hulang/think-api-doc

ThinkPHP8 API 文档自动生成

Maintainers

Details

github.com/hulang/think-api-doc

Source

Issues

Installs: 15

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

Language:HTML

Type:think-extend

1.0.0 2024-05-13 03:46 UTC

Requires

Apache-2.0 472dd32c9636cfb65b420511f720a30dcca1a85a

  • hulang <hulangfy.woop@163.com>

apidocthinkphpapi文档自动生成thinkphp8

This package is auto-updated.

Last update: 2024-05-13 03:47:58 UTC

README

ThinkPHP8 接口文档生成工具

使用方法

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