README

uniadmin

介绍

无侵入的Swagger3/OpenApi3.0接口文档查看工具UI。引用即可生效，无需自己配置路由，无需自己部署swagger-ui到public目录。插件为你做好了一切，基于ThinkPHP6的无侵入OpenApi UI界面，基于swagger-bootstrap-ui制作。

软件架构

基于ThinPHP6的ServiceProvider与Swagger-Bootstrap-UI

发布地址

https://packagist.org/packages/uniadmin/uniadmin-apidoc

安装教程

composer require-dev zircote/swagger-php
composer require-dev uniadmin/uniadmin-apidoc dev-master

写一个文档

在一个控制器比如app/controller/User.php里写一个标准的接开文档如下


/**
 * 用户控制器
 * @OA\Info(title="用户控制器", version="1.0")
 *
 * @author jry <ijry@qq.com>
 */
class User extends BaseController
{
    /**
     * 用户登录
     * 
     * @OA\POST(
     *     tags={"核心模块"},
     *     summary="用户登录",
     *     description="支持账号密码、手机号、邮箱登录",
     *     path="/core/user/login",
     *     @OA\Response(response="200",description="获取成功"),
     *     @OA\Parameter(
     *       name="account",in="query",required=true,description="用户名",
     *       @OA\Schema(type="string")
     *     ),
     *     @OA\Parameter(
     *       name="password",in="query",required=true,description="用户密码",
     *       @OA\Schema(type="string")
     *     )
     * )
     *
     * @param  \think\Request  $request
     * @return \think\Response
     * @author jry <ijry@qq.com>
     */
    public function login(Request $request)
    {
    }
}

注解文档

https://zircote.github.io/swagger-php/

使用说明

访问 {域名:端口}/doc

参与贡献

Fork 本仓库
新建 Feat_xxx 分支
提交代码
新建 Pull Request

uniadmin / uniadmin-apidoc

Maintainers

Details