如题，使用markdown格式写接口文档效率还是挺高的，因为你只需要关系接口的功能和内容，而不用在意排版，顺带提一下使用这个工具markdown_tables创建markdown格式的表格不要太方便！

需要说明的是如果是大型多人合作项目，还是老老实实用apidoc等工具吧。

接口大类
-----------
[toc]
-----------

### 接口1

#### 接口功能

> 接口说明

#### 接口地址

> 接口地址

#### 返回格式

> JSON

#### 请求方式

> GET

#### 请求参数

| 参数 | 必选 | 类型   | 默认值 | 说明                                    |
|------|------|--------|--------|-----------------------------------------|
| name | ture | string | foo    | 请求的项目名                            |
| type | true | int    | bar    | 请求项目的类型。1：类型一；2：类型二 。 |

#### 返回字段

| 返回字段 | 字段类型 | 说明                             |
|----------|----------|----------------------------------|
| result   | int      | 返回结果状态。0：正常；1：错误。 |
| reason   | string   | 错误说明                         |
| data     | string   | 数据                             |

#### 字段变化

字段变化说明

#### 接口示例

> 地址：接口地址示例


#```json
{
    "result": 0,
    "reason": "success",
    "data": []
}
#```

代码里的#请删除

今天在V2EX上发现了一个上搜索微信内容的好网站

http://weixin.sogou.com/

练习爬虫的同学有福了，没事儿干可以试试。

接口地址：

http://weixin.sogou.com/gzhjs

获取方式:

GET

参数:

1. cb 必须 固定值 sogou.weixin.gzhcb

2. openid 必须 公众号的唯一ID，可以通过搜索结果页面获得

3. page 可选 页码 默认第一页 每页最多十条记录

4. t 可选 请求发送的时间，目测没啥大用

最近貌似对openid加密了，等高人破解吧。

dmsYotdg%2F1V4oas03wIdducg7w5SL9M%2BYAL3GsHdR%2Fw9aG9Qzsh6XnA%2FUqKuQ66p8tRkK

oIWsFt4Dl6kREBsD_KrMA84ThiIA

wDssoe6gmmM8o%2FDMnpcWKuHwEPHxqeOZXzd%2FXytWShm4vQlImQmVes2pA7cYWfc%2FwudCK

oIWsFt5sM7wz7isNXkl01is9M834

IAsHogvgG8dho2KKG6sO2uI3QooM18Hx%2BZF7o7%2BjinhzOVx5t3EcYmhn93gQQgsYira4N

oIWsFt0fiD095kHlyHMIXEM7PrZc

M8sGoC2gu6ZRohqri5nKnuau%2FD8g0jkqKyfAW8cjgPLn1e3wwAZSEM%2FMsVhWFQqp7%2Bz%2B9

oIWsFtwFWRis8pbm2-hOgllnpZfw

6Ss7od5gsiLBoala%2BGkVduU4PRslLs6USIzFeWxJXDR4oyMBZNvWwNovVPSmZJ6GVI7PG

oIWsFt4UdPREjjItJo-JsJhoTjSU

Qqsoo2gg7EDuovYnPkpxGu22Hv1%2FLF9MkC4AtaAGVcP%2B49dhr5tmnOpMZFpMtNQfp%2BnRv

oIWsFt-abnxH6yhUGXNtgwhtsvS4

工作中需要微博的商业API，记录一下 不了解的TX先去看说说明 http://open.weibo.com/wiki/商业数据API

商业数据API：包括数据分析、舆情监测、获取全量粉丝三大特性，同时还有实时数据推送、历史数据检索、监测粉丝变化趋势、活跃&活动粉丝分析等多项功能，协助和指引企业开展社会化营销，让真实的用户数据变为企业的决策。

申请试用 申请试用的邮箱为

[email protected] 给这个地址发邮件说明意图即可 这一步挺麻烦的，需要提供很多企业信息，需要注意的是：商业API只提供商业用途，所以如果你的APP的服务对象不是企业，请绕道。 然后填写两张申请单，分别为 订阅服务申请单、REST接口申请单-测试版。 一个是订阅微博，粉丝登上数据用的，另一个是标准API，可以使用搜索等高级接口！

价格

确定试用时间

试用时间一般两周，请充分利用好这宝贵的时间吧！

测试

REST接口很简单，和普通接口一样直接调用。就是订阅接口比较麻烦，当你生成订阅列表后，他会把满足你需要的数据放进一个类似队列的东西，然后你需要不断从这个队列中取出你需要的信息，而且这个获取过程需要HTTP长链接。。。。。。说起来很复杂，其实做起来更复杂 :mad: ！ 下面就来讲讲订阅接口，先看看这两个文档：

• 订阅接口的服务手册 http://open.weibo.com/wiki/Subscription_guide
• 订阅管理接口 http://open.weibo.com/wiki/C/2/subscribe/update_subscribe

看完这两个接口就基本知道了订阅到底是干啥用的。

订阅开启

首先，开启了订阅接口服务以后，你会有推送时间，还有推送IP等很多需要设置的东西，当然完成了这些基本设置后，就可以开始配置订阅规则了，订阅规则基于以下两个条件：

1. 订阅用户

2. 订阅关键字 从subscribe/update_subscribe这个接口的示例来看，订阅有以下特点：

   • 订阅规则即刻生效
   • 规则可以添加，修改
   • 规则可以随时查询
   • 每次修改量很有限（用户：50个；关键词：20个）

使用订阅

添加与删除一样 需要说明的是：

$params['subid'] = '***';  //你的订阅ID 新浪提供
$params['source'] = '***';  //你的APPid


session_start();

include_once( 'config.php' );
include_once( 'saetv2.ex.class.php' );

$c = new SaeTClientV2( WB_AKEY , WB_SKEY , $_SESSION['token']['access_token'] );
$uid_get = $c->get_uid();
$uid = $uid_get['uid'];

//获取所有关注，默认一次50个，可以自己写循环
$friends = $c->friends_by_id($uid);
$subscribe = '';
foreach( $friends['users'] as $value )
{
	$subscribe .= $value['id'].',';
}
$subscribe =  trim($subscribe,',');

//准备数据
$params = array();
$params['subid'] = '***';
$params['source'] = '***';
$params['add_uids'] = $subscribe;
//$params['del_uids'] = $subscribe;

$rs = $c->oauth->get('http://c.api.weibo.com/subscribe/update_subscribe.json', $params);
print_r($rs);


if($rs['result']){
	echo "订阅用户成功";
}

获取订阅信息

可以访问网址：

http://open.weibo.com/apps/yourappid/payservice/subscribe

也可以使用API读取

oauth->get('http://c.api.weibo.com/subscribe/update_subscribe.json', $params);
print_r($rs);