使用文档功能撰写API接口

中扬
中扬 2015/03/31 15:34 7   11224   收藏帖子

最近在写一个在线的API文档,readme.io需要付费,因此就想起了用worktitle的文档功能。
用markdown编辑,显示效果还不错。API格式是复制的微博开放平台的格式。
下面是示例以及markdown代码,有需要的可以借鉴。

显示效果:


目录

  1. 查询指定项目属性接口

1. 查询指定项目属性

接口功能

获取制定项目的分类信息

URL

http://www.api.com/index.php

支持格式

JSON

HTTP请求方式

GET

请求参数
参数 必选 类型 说明
name ture string 请求的项目名
type true int 请求项目的类型。1:类型一;2:类型二 。
返回字段
返回字段 字段类型 说明
status int 返回结果状态。0:正常;1:错误。
company string 所属公司名
category string 所属类型
接口示例

地址:http://www.api.com/index.php?name="可口可乐"&type=1

{
    "statue": 0,
    "company": "可口可乐",
    "category": "饮料",
}

markdown代码:


目录

1. 查询指定项目属性接口

***

**1. 查询指定项目属性**
###### 接口功能
> 获取制定项目的分类信息

###### URL
> [http://www.api.com/index.php](www.api.com/index.php)

###### 支持格式
> JSON

###### HTTP请求方式
> GET

###### 请求参数
> |参数|必选|类型|说明|
|:-----  |:-------|:-----|-----                               |
|name    |ture    |string|请求的项目名                          |
|type    |true    |int   |请求项目的类型。1:类型一;2:类型二 。|

###### 返回字段
> |返回字段|字段类型|说明                              |
|:-----   |:------|:-----------------------------   |
|status   |int    |返回结果状态。0:正常;1:错误。   |
|company  |string | 所属公司名                      |
|category |string |所属类型                         |

###### 接口示例
> 地址:[http://www.api.com/index.php?name="可口可乐"&type=1](http://www.api.com/index.php?name="可口可乐"&type=1)
``` javascript
{
    "statue": 0,
    "company": "可口可乐",
    "category": "饮料",
}

最后少了个“ ``` ”,可以自己补上。

Worktle 免费了

评 论

Terry Terry
03-31 15:39 #2

非常不错的经验分享!

op小泽马 op小泽马
03-31 15:40 #3

艾玛,高大上

anytao anytao
03-31 17:11 #4

超级赞,markdown还是可以玩出各种高大上的。

张立春 张立春
03-31 18:17 #5

真的不错~

罗泽贤 罗泽贤
06-13 12:02 #5
接口示例

地址:http://www.api.com/index.php?name="可口可乐"&type=1

{
    "statue": 0,
    "company": "可口可乐",
    "category": "饮料",
}

补上之后效果不对

罗泽贤 罗泽贤
06-13 12:25 #6
接口示例

地址:http://www.api.com/index.php?name="可口可乐"&type=1 ``` javascript { "statue": 0, "company": "可口可乐", "category": "饮料", }

罗泽贤 罗泽贤
06-13 12:25 #7
接口示例

地址:http://www.api.com/index.php?name="可口可乐"&type=1

{
    "statue": 0,
    "company": "可口可乐",
    "category": "饮料",
}