php apidoc生成接口文档示例

下面我们来看一篇关于php apidoc生成接口文档示例,希望这篇文章能够给各位带来帮助,具体的步骤细节如下文介绍.

api 生成接口文档示例：

{

  "name": "9月份赠险领取分享活动微信接口",

  "version": "1.0.0",

  "description": "9月份赠险领取分享活动微信接口文档 (t=1) ",

  "sampleUrl" : "http://www.phpernote.com/"

}

另存文件名为：apidoc.json

apidoc -i 要生成文档的项目目录 -o 接口文件的生成目录

接口代码文件代码如下：

<?php
/**
 * @api {post} /news/lists 新闻信息列表
 * @apiVersion 1.0.0
 * @apiName lists
 * @apiGroup User
 * @apiPermission 登录用户
 *
 * @apiDescription 用户登录后进入该页面，将显示新闻信息列表
 *
 * @apiSampleRequest /v1/news/lists
 *
 * @apiSuccess (返回值) {string} id 主键ID
 * @apiSuccess (返回值) {string} name 客户姓名
 * @apiSuccess (返回值) {string} user_head_img 客户头像
 * @apiSuccess (返回值) {integer} sex 性别:0-未设置,1-男,2-女
 * @apiSuccess (返回值) {string} demand 客户需求
 *
 * @apiSuccessExample {json} 成功示例:
 * {"code": 1,"msg": "","data": {"id": "57b3cdb46b787","name": "余浩苗","user_head_img": "userHead/2016-08-18/1034587522576.jpg","sex": "1","demand": "本人想买保险，请速联系！"}}
 *
 * @apiErrorExample (json) 错误示例:
 *     {"code":-1,"msg":"密码错误","data":{}}
 */

///////////////////////////////////////

/**
 * @api {post} /news/rob 抢客户
 * @apiVersion 1.0.0
 * @apiName rob
 * @apiGroup User
 * @apiPermission 登录用户
 *
 * @apiDescription 抢客户
 *
 * @apiParam {string} id 主键ID
 *
 * @apiSampleRequest /v1/news/rob
 *
 * @apiSuccessExample {json} 成功示例:
 * {"code":1,"msg":"","data":{}}
 *
 * @apiErrorExample (json) 错误示例:
 *     {"code":-1,"msg":"错误信息","data":{}}
 */

///////////////////////////////////////
更多关于apidoc的用法请参考：http://apidocjs.com/

下面我们来看一篇关于file_get_contents()获取https出现这个错误Unable to find the wrapper “https”问题的解决办法.

file_get_contents()获取https出现这个错误Unable to find the wrapper “https” – did

解决办法一，如果你是用的服务器，可以参考这个办法，修改php配置文件（win主机），来支持https

在php.ini中找到并修改

    extension=php_openssl.dll
    allow_url_include = On

重启服务就可以了，如果你的是linux服务器，linux下的PHP，就必须安装openssl模块，安装好了以后就可以访了。

解决办法二，如果你用的不是服务器，你用的主机，你没法更改php的配置，你可以通过使用curl函数来替代file_get_contents函数，当然你的主机必须支持curl函数。

<?php

function getSslPage($url) {
$ch = curl_init();
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_HEADER, false);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_REFERER, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
$result = curl_exec($ch);
curl_close($ch);
return $result;
}
echo getSslPage($_GET['url']);
?>

检查主机是否支持php的file_get_contents函数

讲一下代码存储为php文件，在空间运行，即可得出结果。

<?php
echo ‘Curl: ‘, function_exists(‘curl_version’) ? ‘Enabled’ : ‘Disabled’ . ‘<br />
file_get_contents: ‘, file_get_contents(__FILE__) ? ‘Enabled’ : ‘Disabled’;
?>
 

下面我们来看一篇关于file_get_contents url 含有特殊字符获取失败问题处理的问题,希望文章能够帮助到各位朋友.

file_get_contents 在文件名包含特殊符号的时候回遇到处理失败的情况，解决办法是使用urlencode函数处理下文件名。

<?php

$name='包含特殊符的文件名';
$name=urlencode($name);

$url = "http://phpff.com/{$name}.jpg";
$con = file_get_contents($url);
?>

知识扩充

file_get_contents()模拟referer,cookie, 使用proxy等等

参考代码

ini_set('default_socket_timeout',120);
ini_set('user_agent','MSIE 6.0;');
$context=array('http' => array ('header'=> 'Referer: http://www.baidu.com/', ),);
$xcontext = stream_context_create($context);
echo $str=file_get_contents('http://www.111cn.net/',FALSE,$xcontext);

下面是file_get_contents和curl两个函数同样功能的不同写法

file_get_contents函数的使用示例:

< ?php

$file_contents = file_get_contents(‘http://www.zoneself.org/’);

echo $file_contents;

?>
换成curl函数的使用示例:

< ?php

$ch = curl_init();

$timeout = 5;

curl_setopt ($ch, CURLOPT_URL, ‘http://www.ccvita.com’);

curl_setopt ($ch, CURLOPT_RETURNTRANSFER, 1);

curl_setopt ($ch, CURLOPT_CONNECTTIMEOUT, $timeout);

$file_contents = curl_exec($ch);

curl_close($ch);

echo $file_contents;

?>
利用function_exists函数来判断php是否支持一个函数可以轻松写出下面函数:

< ?php

function vita_get_url_content($url) {

if(function_exists(‘file_get_contents’)) {

$file_contents = file_get_contents($url);

} else {

$ch = curl_init();

$timeout = 5;

curl_setopt ($ch, CURLOPT_URL, $url);

curl_setopt ($ch, CURLOPT_RETURNTRANSFER, 1);

curl_setopt ($ch, CURLOPT_CONNECTTIMEOUT, $timeout);

$file_contents = curl_exec($ch);

curl_close($ch);

}

return $file_contents;

}

?>

 
          其实上面的这个函数还有待商榷，如果你的主机服务商把file_get_contents和curl都关闭了，上面的函数就会出现错误。那最后的办法就得换空间或者在支持的空间上写接口，在不支持的空间上进行调用了。

在php中替换字符串我们要用到repalce但如果要在指定行号替换我们可以对策上面的一篇php根据行号替换字符串的例子,具体如下.

php要实现根据行号替换内容，使用str_replace这样的函数是无法实现的，可以先根据换行符把文本分割成数字，然后便利数组实现替换功能。

<?php
$url='z.txt';
$content=file_get_contents($url);
$contentArr=explode("\n",$content);
$ikey=0;
foreach($contentArr as &$val){
    if(strpos($val, '<!–nextpage–>') !== false){
        $val=$ikey.' '.$val;
        $ikey++;
    }
}
   
$content=implode("\n",$contentArr);
?>

补充

1. preg_replace()

$msg = preg_replace("/<style>.+<\/style>/is", "", $msg); -----删除<style></style>和中间的部分
$msg = preg_replace("/<[^>]+>/", "", $msg); -----是删除<>和中间的内容

i (PCRE_CASELESS)
如果设定此修正符，模式中的字符将同时匹配大小写字母。
s (PCRE_DOTALL)
如果设定了此修正符，模式中的圆点元字符（.）匹配所有的字符，包括换行符。没有此设定的话，则不包括换行符。这和 Perl 的 /s 修正符是等效的。排除字符类例如 [^a] 总是匹配换行符的，无论是否设定了此修正符。

2. ereg()与eregi()

注： preg_match() 函数通常是比 ereg() 更快的替代方案

eregi("<body([^>]+)>(.+)</body>",$data,$b)----察看$data中是否有body标签。如果有，把参数赋值$b[0]，中间部分赋值$b[1]。

bool ereg ( string pattern, string string [, array regs] )

int eregi ( string pattern, string string, array [regs] )

eregi()和 ereg() 类似，用法也相同。不同之处在于ereg()有区分大小写，eregi()与大小写无关。