获取开发文档

方法概览

项目	内容
文档类型	PHP 类方法
方法标识	`app\common\logic\DocLogic::doc`
所属业务	公共接口
来源模块/系统	开发文档逻辑

功能说明

获取开发文档

调用示例

$result = (new \app\common\logic\DocLogic())->doc();

参数

该函数/方法无需传入参数。

返回值

返回项	类型	说明
`返回值`	`array`	—
`[].section`	`string`	版块
`[].doc`	`object`	文档
`[].doc.title`	`string`	标题
`[].doc.desc`	`string`	描述
`[].list`	`array`	版块文档列表
`[].list[].class`	`string`	分类
`[].list[].doc`	`object`	文档
`[].list[].doc.title`	`string`	标题
`[].list[].doc.desc`	`string`	描述
`[].list[].doc.use`	`string`	内部引用
`[].list[].list`	`array`	分类文档列表
`[].list[].list[].method`	`string`	方法
`[].list[].list[].doc`	`object`	文档
`[].list[].list[].doc.title`	`string`	标题
`[].list[].list[].doc.desc`	`string`	描述
`[].list[].list[].doc.author`	`string`	作者
`[].list[].list[].doc.version`	`string`	版本
`[].list[].list[].doc.url`	`string`	请求地址
`[].list[].list[].doc.method`	`string`	请求方式
`[].list[].list[].doc.param`	`object`	请求参数
`[].list[].list[].doc.param.type`	`string`	类型
`[].list[].list[].doc.param.name`	`string`	名称
`[].list[].list[].doc.param.default`	`string`	默认值
`[].list[].list[].doc.param.desc`	`string`	描述
`[].list[].list[].doc.param.validate`	`string`	验证规则
`[].list[].list[].doc.return`	`object`	返回参数
`[].list[].list[].doc.return.type`	`string`	类型
`[].list[].list[].doc.return.name`	`string`	名称
`[].list[].list[].doc.return.default`	`string`	默认值
`[].list[].list[].doc.return.desc`	`string`	描述

正常返回

{
  "section": "string",
  "doc": {
    "title": "示例名称",
    "desc": "string"
  },
  "list": [
    {
      "class": "string",
      "doc": {
        "title": "示例名称",
        "desc": "string",
        "use": "string"
      },
      "list": [
        {
          "method": "string",
          "doc": {
            "title": "示例名称",
            "desc": "string",
            "author": "string",
            "version": "string",
            "url": "https://example.com/callback",
            "method": "string",
            "param": {
              "type": "string",
              "name": "示例名称",
              "default": "string",
              "desc": "string",
              "validate": "2026-07-20"
            },
            "return": {
              "type": "string",
              "name": "示例名称",
              "default": "string",
              "desc": "string"
            }
          }
        }
      ]
    }
  ]
}

异常情况

异常类型	说明
`Throwable`	调用失败时由具体实现抛出异常，异常信息以运行时结果为准。

本页目录