uniadmin-apidoc

接口文档查看工具 UI
授权协议 Apache
开发语言 JavaScript
所属分类 Web应用开发、 后台管理系统(模板)
软件类型 开源软件
地区 国产
投 递 者 乔俊才
操作系统 跨平台
开源组织
适用人群 未知
 软件概览

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

软件架构

基于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

 相关资料
  • 接口管理平台(Netease Easy Interface),简称 NEI。NEI 虽然叫接口管理平台,但其实不只是管理接口,它可以管理整个产品,也具备项目脚手架的功能。本文介绍 NEI 的设计理念和一些名词的含义。

  • 文件系统查看工具 在iOS设备上可以安装iExplorer, iFunbox, iTool等工具,可以查看iOS应用的文件系统结构。 我们以iFunbox为例子,介绍下其用法。 下载安装 从这里下载iFunbox最新的Mac版本,然后安装。 打开iFunbox,点击左边的User Applications,然后点击你想打开的应用的图标,比如选择陌陌。打开陌陌的文件目录的示意图如下所示: 选择某个应

  • 1. 标题栏 NT_UI.setHeader(name, style); 列表 可选值 背景色 颜色 悬浮色 大小 间距 圆角 标题栏 wrapper true 标题栏-客服头像 kefuLogo true true true 标题栏-客服名称 kefuName true 标题栏-客服个性签名 kefuSignature true 标题栏-最小化按钮 min true true 标题栏-关闭按钮

  • 初始化 xn('init') 停止默认初始化 xn('stopAutoInit'); 设置访客信息 // customerinfo的可选健值见下表 xn('setCustomerInfo', JSONObject customerinfo); 参数名称 类型 备注 默认值 uid String 用户id 无 uname String 用户名称 无 userlevel String 用户等级

  • 本文向大家介绍使用apidoc管理RESTful风格Flask项目接口文档方法,包括了使用apidoc管理RESTful风格Flask项目接口文档方法的使用技巧和注意事项,需要的朋友参考一下 使用apidoc管理RESTful风格Flask项目接口文档方法 apidoc项目地址 flask扩展包地址 文档示例地址 1.安装nodejs 2.安装apidoc 3.Flask扩展包安装 4.添加扩展包

  • 对于某些应用程序来说,窗口查看围绕特定主题的多个文档是很有用的。上下文视图能够帮助设置包含时序性事件的索引模式。 想要显示与锚文档相关的上下文,点击文档表条目左侧的 Expand 按钮 ,然后点击 View surrounding documents 链接。 上下文视图会显示锚文档前后的多个文档。锚文档会用蓝色突出显示。该视图是根据索引模式配置的时间字段而检索出的结果,并使用 Discover 浏