menu

生成文档

在 ApiController 构造函数中, 如果发现请求带有 doc_token 参数会进入特殊处理流程，通过反射扫描控制器目录，获取所有类 api相关注解 获得注解之后, 再按规则生成API调试表单。

安装后台管理系统

先安装安装后台管理系统

默认用户名 admin， 密码 6个0

添加文档

点击左侧导航 文档 - 添加文档, 填写文档基础信息 添加文档

接口签名

接口签名配置位于 app/api/init.php 配置文件中 encrypt[doc] 字段

/**
 * 系统中用到的各种密钥
 * uri 加密URL
 * auth 加密cookie
 * doc 生成调试文档时
 */
'encrypt' => [
    'uri' => '*&9wru&!@#%#&',
    'auth' => '!@#cr@!$!21p#$%^',
    'doc' => 'Qe@#$%&qfd1!23sa',
],

为了接口安全,请修改默认配置

公共参数

所有接口都必须要传的参数,自动附加在生成的表单后面。比如platform, sign, token等, 可以在类或方法中使用注解@cp_global_params关闭

Header参数

指定之后只能通过curl请求接口

部署服务器

名称、地址按表单填写, 多个环境分别配置

文档页面

右上角绿点表示当前服务器状态，和服务器列表， 代码生成可以根据粘贴的json结构生成对应的flutter和golang结构

文档页面

调试表单

点击 试一试 打开新的浏览器标签，并请求对应接口， 建议安装对应的JSON美化插件 。 CURL 除了接口数据之外，还会生成 golang 和 flutter 对应的结构。

文档结果

源码位于 app/admin/supervise/CodeSegment， 可以根据需求扩展