资料介绍
软件简介
基于 tp6 的 api 生成模块,参考 fastadmin 的 api 模块
引用
use jmwl\realapidoc\Builder; use think\facade\View;
使用
这里是所有的需要生成api的控制器路径啦、所以,你可以先获取到模块下的所有控制器 Builder(["\app\admin\controller\Demo","\app\admin\controller\Index"])
$title="类名"; $url="http://real-think.jmwl51.com"; $lang=[ 'Info' => '基础信息', 'Sandbox' => '在线测试', 'Sampleoutput' => '返回示例', 'Headers' => 'Headers', 'Parameters' => '参数', 'Body' => '正文', 'Name' => '名称', 'Type' => '类型', 'Required' => '必选', 'Description' => '描述', 'Send' => '提交', 'Reset' => '重置', 'Tokentips' => 'Token在会员注册或登录后都会返回,WEB端同时存在于Cookie中', 'Apiurltips' => 'API接口URL', 'Savetips' => '点击保存后Token和Api url都将保存在本地Localstorage中', 'Authorization' => '权限', 'NeedLogin' => '登录', 'NeedRight' => '鉴权', 'ReturnHeaders' => '响应头', 'ReturnParameters' => '返回参数', 'Response' => '响应输出', ]; $config = [ 'sitename' => "测试", 'title' => $title, 'author' => "测试", 'description' => '', 'apiurl' => $url, 'language' => $lang, ]; //这里是所有的需要生成api的控制器路径啦 $builder = new Builder(["\\app\\admin\\controller\\Demo","\\app\\admin\\controller\\Index"]); $content = $builder->render(root_path()."/extend/jmwl/realapidoc/template/index.html", ['config' => $config, 'lang' => $lang]); // dump($content); die; View::assign('config',$config); View::assign('docslist',$content["docsList"]); View::assign('lang',$content["lang"]); return View();
视图
文件中的index.html就是视图啦,放到正确的位置 我放在了 app\admin\view\api\index.html 对应的控制器自然是 admin下的api控制器啦
控制器注释
名称 | 描述 | 示例 |
---|---|---|
@ApiSector | API分组名称 | (测试分组) |
@ApiRoute | API接口URL,此@ApiRoute只是基础URL | (/api/test) |
@ApiInternal | 忽略的控制器,表示此控制将不加入API文档 | 无 |
@ApiWeigh | API方法的排序,值越大越靠前 | (99) |
控制器方法注释
名称 | 描述 | 示例 |
---|---|---|
@ApiTitle | API接口的标题,为空时将自动匹配注释的文本信息 | (测试标题) |
@ApiSummary | API接口描述 | (测试描述) |
@ApiRoute | API接口地址,为空时将自动计算请求地址 | (/api/test/index) |
@ApiMethod | API接口请求方法,默认为GET | (POST) |
@ApiSector | API分组,默认按钮控制器或控制器的@ApiSector进行分组 | (测试分组) |
@ApiParams | API请求参数,如果在@ApiRoute中有对应的{@参数名},将进行替换 | (, , required=true, ) |
@ApiHeaders | API请求传递的Headers信息 | (name=token, type=string, required=true, ) |
@ApiReturn | API返回的结果示例 | ({"code":1,"msg":"返回成功"}) |
@ApiReturnParams | API返回的结果参数介绍 | (, , required=true, ) |
@ApiReturnHeaders | API返回的Headers信息 | (, , required=true, ) |
@ApiInternal | 忽略的方法,表示此方法将不加入文档 | 无 |
@ApiWeigh | API方法的排序,值越大越靠前 | (99) |
示范
namespace app\api\controller; /** * 测试API控制器 */ class Test extends \app\common\controller\Api { // 无需验证登录的方法 protected $noNeedLogin = ['test']; // 无需要判断权限规则的方法 protected $noNeedRight = ['*']; /** * 首页 * * 可以通过@ApiInternal忽略请求的方法 * @ApiInternal */ public function index() { return 'index'; } /** * 私有方法 * 私有的方法将不会出现在文档列表 */ private function privatetest() { return 'private'; } /** * 测试方法 * * @ApiTitle (测试名称) * @ApiSummary (测试描述信息) * @ApiSector (测试分组) * @ApiMethod (POST) * @ApiRoute (/api/test/test/id/{id}/name/{name}) * @ApiHeaders (name=token, type=string, required=true, ) * @ApiParams (, , required=true, ) * @ApiParams (, , required=true, ) * @ApiParams (, , , ) * @ApiReturnParams (, , required=true, ) * @ApiReturnParams (, , required=true, ) * @ApiReturnParams (, , , ) * @ApiReturn ({ 'code':'1', 'mesg':'返回成功' * }) */ public function test($id = '', $name = '') { $this->success("返回成功", $this->request->request()); } }
下载该资料的人也在下载
下载该资料的人还在阅读
更多 >
- 生成式AI对智能家居的影响 12次下载
- LabView工具包WebSocket-API主机下载 65次下载
- real-token基于tp6的权限验证模块 0次下载
- TP8111A线性恒流供电电路图 12次下载
- 爱华微胶囊记录器TP-M725/TP-M525数据手册 0次下载
- TP-LINK无线路由器升级软件及说明 1次下载
- 16位CRC验证码生成VI工具下载 50次下载
- 演示版:NanEye_EvalSW_API_FiberOpticBox_csharp_pWin_v2-3-3-1.exe 0次下载
- 演示版:NanEye2D_EvalSW_API_NanoUSB2_cpackage_pWin_v1-1-3-1.exe 0次下载
- MPLAB REAL ICE在线仿真器功率监视器开发工具的详细中文资料概述 16次下载
- MPLAB REAL ICE在线仿真器功率监视器的介绍和使用指南详细概述 8次下载
- MPLAB REAL ICE在线仿真器隔离器单元 11次下载
- Connecting_Real_People_with_Real_Solutions 5次下载
- 利用C API实现基于RTX实时仿真系统的在线调参 36次下载
- L2TP虚拟专用网 16次下载
- Kubernetes Gateway API攻略教程 191次阅读
- N-API的JS堆对象生命周期管理 175次阅读
- DDS信号生成模块的Verilog实现 352次阅读
- 企业怎么选择API网关 357次阅读
- Katalon:API测试 554次阅读
- 什么是API,不同场景中的API 1634次阅读
- 基于使用TP-4056模块制造锂离子电池充电器设计 5427次阅读
- 英飞凌REAL3 ToF传感器的背后技术揭秘 2059次阅读
- 什么是API网关为什么需要API网关 1.2w次阅读
- tp4055中文资料汇总(tp4055引脚图功能_内部结构及应用电路) 2.6w次阅读
- tp4056充电保护电路图(八款tp4056锂电池充电电路详解) 33w次阅读
- TP4056使用注意事项 5w次阅读
- 如何搭建API程序_框架api接口规范 1.1w次阅读
- 如何使用API_api接口有什么优点 2w次阅读
- TP14管脚图 2915次阅读
下载排行
本周
- 1山景DSP芯片AP8248A2数据手册
- 1.06 MB | 532次下载 | 免费
- 2RK3399完整板原理图(支持平板,盒子VR)
- 3.28 MB | 339次下载 | 免费
- 3TC358743XBG评估板参考手册
- 1.36 MB | 330次下载 | 免费
- 4DFM软件使用教程
- 0.84 MB | 295次下载 | 免费
- 5元宇宙深度解析—未来的未来-风口还是泡沫
- 6.40 MB | 227次下载 | 免费
- 6迪文DGUS开发指南
- 31.67 MB | 194次下载 | 免费
- 7元宇宙底层硬件系列报告
- 13.42 MB | 182次下载 | 免费
- 8FP5207XR-G1中文应用手册
- 1.09 MB | 178次下载 | 免费
本月
- 1OrCAD10.5下载OrCAD10.5中文版软件
- 0.00 MB | 234315次下载 | 免费
- 2555集成电路应用800例(新编版)
- 0.00 MB | 33566次下载 | 免费
- 3接口电路图大全
- 未知 | 30323次下载 | 免费
- 4开关电源设计实例指南
- 未知 | 21549次下载 | 免费
- 5电气工程师手册免费下载(新编第二版pdf电子书)
- 0.00 MB | 15349次下载 | 免费
- 6数字电路基础pdf(下载)
- 未知 | 13750次下载 | 免费
- 7电子制作实例集锦 下载
- 未知 | 8113次下载 | 免费
- 8《LED驱动电路设计》 温德尔著
- 0.00 MB | 6656次下载 | 免费
总榜
- 1matlab软件下载入口
- 未知 | 935054次下载 | 免费
- 2protel99se软件下载(可英文版转中文版)
- 78.1 MB | 537798次下载 | 免费
- 3MATLAB 7.1 下载 (含软件介绍)
- 未知 | 420027次下载 | 免费
- 4OrCAD10.5下载OrCAD10.5中文版软件
- 0.00 MB | 234315次下载 | 免费
- 5Altium DXP2002下载入口
- 未知 | 233046次下载 | 免费
- 6电路仿真软件multisim 10.0免费下载
- 340992 | 191187次下载 | 免费
- 7十天学会AVR单片机与C语言视频教程 下载
- 158M | 183279次下载 | 免费
- 8proe5.0野火版下载(中文版免费下载)
- 未知 | 138040次下载 | 免费
评论
查看更多