BFWSOA框架如何实时自动生成接口文档
在app或小程序开发的过程中，我们经常要写接口文档，导致接口文档与接口更新缓慢不匹配问题，而且增加了接口人员的工作量。
今天BFWSOA框架内置了接口文档自动生成机制，让你专注于接口逻辑的实现，文档会根据注释自动生成、
自动生成，还可以在线调试接口
那么怎么打开这个页面呢
其实在开发过程中备注的时候注意一下几点就行了
<?php
namespace App\Demo\Controler;
use Lib\BoControler;
/**
*
* @author bfw
* <t>用户模块</t>
* <d> 用户登录注册相关接口</d>
*/
class Controler_Member extends BoControler
{
/**
* <t>用户登录</t>
* method POST
* @param string mobile 手机号 必填
* @param string code 验证码 必填
* 返回json{"status":200,"data":"xxxx"}
*/
function Login($mobile = "", $code = "")
{
return [
"status" => 200,
"data" => "登录成功"
];
}
}
?>这是用bfwsoa编写的接口，我们看到注释的标题我们使用<t>标题</t>表示，注释的描述我们用<d>描述</d>来表示然后还要更改配置文件，在项目的config目录下有一个config.php,将show_apidoc设为true，表示打开
<?php
$_config_arr['App'] = [
"show_apidoc"=>true,
];
?>最后在项目访问域名的后面加上?getapidoc=1&route=2,就可以打开接口文档了
{{collectdata}}
网友评论0