thinkphp返回的json数据无法变成数组_Thinkphp中用Apidoc生成接口文档

本文档介绍了如何在Thinkphp框架中利用Apidoc来创建接口文档。首先,详细讲述了Apidoc的功能,接着指导如何安装node.js和Apidoc。然后,展示了如何配置apidoc.json文件,并提供了各种Apidoc注解的使用示例,如@api, @apiVersion等。最后,说明了如何在项目根目录通过命令行生成接口文档。" 112162907,10543728,Vue前端直传OSS大文件:利用STS授权与分片上传,"['前端开发', 'Vue', '阿里云OSS', '文件上传', '权限管理']
摘要由CSDN通过智能技术生成

e3f8c0dc5cf0e3a5a9928da9d1a80d65.png

Thinkphp中用Apidoc生成接口文档

一.Apidoc

apidoc能做什么 apidoc是一个轻量级的在线REST接口文档生成系统,可以根据其特定的规则的代码注释来生成静态网页。

二.Apidoc使用

1.安装node.js

Node.js 是一个基于 Chrome V8 引擎的 JavaScript 运行时。 Node.js 使用高效、轻量级的事件驱动、非阻塞 I/O 模型。Node.js 的生态系统是目前最大的开源包管理系统。下载地址: https:// nodejs.org/zh-cn/

2.安装Apidoc

npm install apidoc -g

3.配置

在你的项目根目录或应用目录下新建 apidoc.json文件,该文件描述了项目对外提供接口的概要信息如名称、版本、描述、文档打开时浏览器显示标题和接口缺省访问地址。

apidoc.json

{
  "name": "example",
  "version": "0.1.0",
  "description": "apiDoc basic example",
  "title": "Custom apiDoc browser title",
  "url" : "https://api.github.com/v1"
}

json配置

更详细的说明请参考官方文档http://apidocjs.com

4.使用

公共部分定义

Thinkphp可以在继承的公共控制器文件Base.php文件中定义

Base.php

// ==========================================================================================
    // 公共部分定义-响应字段说明
    // ==================
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值