EasyApi
通过简单配置，实时生成简易的在线API文档。 本代码适用于较简单的REST风格的项目，可帮助随时生成简易API文档，方便前后端快速开发。较为复杂的接口设计，可根据自己需求对代码进行修改，便于自己的开发。
配置方法
默认使用actionIndex和actionDetail作为前后页，如有不同，大家可自行修改ApiCommon。 以下是支持的数据类型。
'string' => '字符串',
'text' => '文本',
'int' => '整型',
'float' => '浮点型',
'boolean' => '布尔型',
'date' => '日期',
'datetime' => '时间',
'array' => '数组',
'enum' => '枚举类型',
'object' => '对象',
"file"=>"文件",
以下是配置具体示例，我用的是Yii框架，不过代码与框架无关，修改后，任何场景都可使用。
<?php
namespace frontendcontrollers;
use Yii;
use yiiwebController;
use commonlibApiCommon;
class ApiController extends Controller
{
public $enableCsrfValidation = false;
public function actionIndex(){
ApiCommon::showContent($this->theRules());
}
public function actionDetail(){
ApiCommon::showDetail($_GET["flag"],$this->theRules());
}
private function theRules(){
return array(
"part"=>"front",
"member"=>$this->memberPart(),
"help"=>$this->helpPart(),
"common"=>$this->commonPart(),
);
}
private function commonPart(){
return array(
'发送验证码' => array(
"with"=>"/send-verify-code",
'method' => "POST",
"params" => array(
"phone"=> array(
'desc' => '手机号',
'max' => '32',
),
"type"=> array(
'desc' => '验证码类型',
'type'=>"enum",
"range"=>array(
1=>"register",
2=>"forget-password",
),
"other"=>"分别代表注册时验证码、忘记密码时验证码。",
),
),
"noToken"
),
'单文件上传' => array(
"with"=>"/upfile",
'method' => "POST",
'content-type' => "multipart/form-data",
"params" => array(
"theFile"=> array(
'desc' => '文件',
'type' => 'file',
),
),
"noToken"
),
);
}
private function helpPart(){
return array(
'帮助信息' => array(
"with"=>"/{id}",
"noToken"
),
'帮助列表' => array(
"noToken"
),
);
}
private function memberPart(){
return array(
'注册' => array(
'method' => "POST",
"params" => array(
"nickName"=>"昵称",
"trueName"=> "真实姓名",
"password"=> array(
'desc' => '密码',
'min' => '6',
),
"phone"=> array(
'desc' => '手机号',
'max' => '32',
),
"verifyCode"=>"验证码",
'email' => '邮箱',
),
"noToken"
),
'登录' => array(
"with"=>"/login",
'method' => "POST",
"params" => array(
"phone"=> array(
'desc' => '手机号',
'max' => '32',
),
"password"=> array(
'desc' => '密码',
'min' => '6',
),
),
"noToken"
),
'修改信息' => array(
"with"=>"/{id}",
'method' => "PUT",
"params" => array(
"nickName"=>"昵称",
"trueName"=> "真实姓名",
"email"=> "邮箱",
)
),
'修改密码' => array(
"with"=>"/update-password",
'method' => "POST",
"params" => array(
"password"=> array(
'desc' => '原始密码',
'min' => '6',
),
"newPassword"=> array(
'desc' => '密码',
'min' => '6',
),
)
),
'忘记密码时重置密码' => array(
"with"=>"/update-password-forget",
'method' => "POST",
"params" => array(
"phone"=> array(
'desc' => '手机号',
'max' => '32',
),
"newPassword"=> array(
'desc' => '密码',
'min' => '6',
),
"verifyCode"=>"验证码",
),
"noToken"
),
'用户信息' => array(
"with"=>"/{id}",
),
);
}
}
版权声明：
1、该文章(资料)来源于互联网公开信息，我方只是对该内容做点评，所分享的下载地址为原作者公开地址。2、网站不提供资料下载，如需下载请到原作者页面进行下载。
3、本站所有内容均由合作方或网友上传，本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺！文档内容仅供研究参考学习用！
4、如文档内容存在违规，或者侵犯商业秘密、侵犯著作权等，请点击“违规举报”。
