使用文档功能撰写API接口
最近在写一个在线的API文档,readme.io需要付费,因此就想起了用worktitle的文档功能。
用markdown编辑,显示效果还不错。API格式是复制的微博开放平台的格式。
下面是示例以及markdown代码,有需要的可以借鉴。
显示效果:
目录
- 查询指定项目属性接口
1. 查询指定项目属性
接口功能
获取制定项目的分类信息
URL
支持格式
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": "饮料",
}
最后少了个“ ``` ”,可以自己补上。
非常不错的经验分享!
艾玛,高大上
超级赞,markdown还是可以玩出各种高大上的。
真的不错~
接口示例
补上之后效果不对
接口示例
接口示例