zhangzhuow/document

thinkphp5.0 接口文档生成器

1.0 2019-08-08 01:27 UTC

Requires

• php: >=5.6
• topthink/framework: 5.0.*

MIT

• zhangzhuowei

• api
• thinkphp

README

• 安装要求
• 安装
• 使用方式
• 可以使用的参数

安装要求

PHP >= 5.3.2

thinkphp = 5.0.*

安装

使用composer安装

$ composer require zhangzhuow/document

使用方式

<?php

namespace Document\Command;

/**
 * @ApiTitle  (name)  此参数为必须
 */
class User
{
    /**
     * @ApiTitle  (name)  此参数为必须
     * @ApiDescription(section="User", description="Get information about user")
     * @ApiMethod(type="get")
     * @ApiRoute(name="/user/get/{id}")
     * @ApiParams(name="id", type="number", value="value" nullable=false, description="User id")
     * @ApiParams(name="data", type="object", sample="{'user_id':'int','user_name':'string','profile':{'email':'string','age':'integer'}}")
     * @ApiReturnHeaders(sample="HTTP 200 OK")
     * @ApiReturn(type="object", sample="{
     *  'transaction_id':'int',
     *  'transaction_status':'string'
     * }")
     */
    public function get()
    {

    }

    /**
     * @ApiTitle  (name)  此参数为必须
     * @ApiDescription(section="User", description="Create's a new user")
     * @ApiMethod(type="post")
     * @ApiRoute(name="/user/create")
     * @ApiParams(name="username", type="string", nullable=false, description="Username")
     * @ApiParams(name="email", type="string", nullable=false, description="Email")
     * @ApiParams(name="password", type="string", nullable=false, description="Password")
     * @ApiParams(name="age", type="number", nullable=true, description="Age")
     */
    public function create()
    {

    }
}

配置command.php文件，目录在application/command.php

<?php
return [
    'app\home\command\Test',
];

将扩展包config文件夹内的site.php拷贝至application/extra文件夹

执行ThinkPHP命令行会新增一个api命令

$ php think -l

Think Console version 0.1

Usage:
  command [options] [arguments]

Options:
  -h, --help            Display this help message
  -V, --version         Display this console version
  -q, --quiet           Do not output any message
      --ansi            Force ANSI output
      --no-ansi         Disable ANSI output
  -n, --no-interaction  Do not ask any interactive question
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Available commands:
  api                 Build Api document from controller
  build               Build Application Dirs
  clear               Clear runtime file
  help                Displays help for a command
  list                Lists commands
 make
  make:controller     Create a new resource controller class
  make:model          Create a new model class

执行api命令生成html文档

$ php think api

html文档位置为public目录

可以使用的参数

• @ApiTitle (name)
• @ApiDescription(section="...", description="...")
• @ApiMethod(type="(get|post|put|delete|patch")
• @ApiRoute(name="...")
• @ApiParams(name="...", type="...", nullable=..., required="...", value="...", description="...", [sample=".."])
• @ApiHeaders(name="...", type="...", nullable=..., required="...", value="...", description="...")
• @ApiReturnHeaders(sample="...")
• @ApiReturn(type="...", sample="...")
• @ApiBody(sample="...")

只会生成带有@ApiTitle参数的方法和类