接口文档是你写完接口后或对接接口时必备的文档,有了详细的接口文档,工作上就可以节约很多时间来玩几把王者了
这里简单介绍一下接口文档easydoc文档插件的使用
easydoc文档插件可以自动的帮你生成接口文档,而不须要你自己去写各种文档参数
先下载插件在后台进行安装,接下我说一下怎么使用
插件是对“控制器注解”进行解析说明的,其中要进行解析的api类是通过配置文件easydoc\data\config.php配置的
<?php
return [
'title' => "APi接口文档", //文档title
'version'=>'2.0.1', //文档版本
'copyright'=>'Powered By TPFrame', //版权信息
'controller' => [
//需要生成文档的类
"addon\\easydoc\\controller\\Posts"
],
......
其中的controller就是指定要解析的类,这里的addon\\easydoc\\controller\\Posts是写的一个案例,多个类用用逗号分隔写在里面就可以了
写api就像写正常的逻辑一样的,只是返回的数据按照一定要求,验证的时候严格规范一些验证摆了,下面我简单说一下注解的意思
/**
* @title 帖子接口类
* @description
* @group APP接口
* Class Posts
* @package addon\easydoc\controller
* 这是一个api接口测试类,可参考此类进行开发
*/
class Posts ...
可以看到在类的上面有这么一个注解,title表示接口总的名称,group是对接口进行分组的组名,再看方法里面的注解
class Posts extends AddonFrontBase
{
/**
* @title 添加帖子
* @description 通过接口添加帖子
* @author TPFrame
* @url /easydoc/Posts/add/
* @method POST
* @param_send name:title type:string require:1 default:空字符串"" other:3-100长度 desc:文章标题
* @param_send name:content type:string require:1 default:空字符串"" other:2000内长度 desc:文章内容
* @param_send name:source type:string require:0 default:tpframe other:20字符串 desc:文章来源
* @param_send name:author type:string require:0 default: other:20字符串 desc:作者
*/
public function add(){
$this->jump(Core::loadAddonModel($this->name)->savePosts($this->param));
}
....
url表示接口的地址,这里是绝对地址哦,param_send表示发送的参数,name参数名,type参数类型,requre是否必须,default默认值,other其它说明,desc描述
上面的数据结果如下图

前台所有参数都是自动生成的,不用你会写,你只关心把配置写好
全部写好后你还可以在线直接测试你的接口,默认用的是当前域名作为测试域名,你可以在插件目录下addon\easydoc\config\config.php里面更改api的域名地址
OK,基本的使用就这些
文章由TPFrame发布,谢绝转载!