uniadmin-apidoc 正在参加 2020 年度 OSC 中国开源项目评选,请投票支持!
uniadmin-apidoc 在 2020 年度 OSC 中国开源项目评选 中已获得 {{ projectVoteCount }} 票,请投票支持!
投票让它出道
已投票
uniadmin-apidoc 获得 2020 年度 OSC 中国开源项目评选「最佳人气项目」 !
uniadmin-apidoc 获得 2020 年度 OSC 中国开源项目评选「最佳人气项目」「最积极运营项目」 !
uniadmin-apidoc 获得 2020 年度 OSC 中国开源项目评选「最积极运营项目」 !
授权协议 Apache
操作系统 跨平台
软件类型 开源软件
开源组织
地区 国产
投 递 者 ijry
适用人群 未知
收录时间 2021-05-18

软件简介

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

uniadmin

软件架构

基于ThinPHP6的ServiceProvider与Swagger-Bootstrap-UI

安装教程

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

写一个文档

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

/**
 * 用户登录
 * 
 * @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)
{
}

使用说明

访问 {域名:端口}/doc

展开阅读全文

代码

的 Gitee 指数为
超过 的项目

评论 (0)

加载中
更多评论
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
暂无内容
0 评论
6 收藏
分享
OSCHINA
登录后可查看更多优质内容
返回顶部
顶部