yapi/ydoc.json

144 lines
5.7 KiB
JSON
Raw Normal View History

2017-07-06 19:21:54 +08:00
{
2017-07-28 23:31:35 +08:00
"name": "YApi",
2017-07-28 21:13:51 +08:00
"dest": "static/doc",
2017-07-06 19:21:54 +08:00
"examplePath": "./exampleCode",
"defaultGrammar": "json",
"instructionsInfoPath": "", //使用说明 内容路径 (需要配合JS-Component注释的@instructions使用)
"instructionsUrlPath": "", //使用说明demo路径 (需要配合JS-Component注释的@instructions使用)
"common": { // 通用默认配置,包括主页配置等
2017-07-28 23:31:35 +08:00
"title": "YApi", //page title
2017-07-06 19:21:54 +08:00
"footer": "&copy; 2016 <a href=\"http://ued.qunar.com/ymfe/\">YMFE</a> Team. Build by <a href=\"http://ued.qunar.com/ydoc/\">ydoc</a>.", // 通用尾
"home": "YMFE", // logo
"homeUrl": "http://ued.qunar.com/ymfe/" // logourl
},
"options": {
2017-08-30 15:53:48 +08:00
"foldcode": true,
"markdown": { // 对于 markdown 编译器进行统一配置
"menuLevel": 2 //选取第几级 head 作为目录,默认 -1 没有目录
}
2017-07-06 19:21:54 +08:00
},
"pages": [{
"name": "index", // Page Name 会根据他生成 html 文件,例: index.html
"title": "首页", // Page Title
2017-08-30 15:53:48 +08:00
"homepage": { // 配置首页,样式区别于其他页面
2017-07-28 23:31:35 +08:00
"version": "v1.0.0", // 版本信息将显示在banner底部
2017-07-28 21:15:35 +08:00
"button": [{ // 按钮组将显示在banner底部
"name": "开始",
2017-08-24 17:30:27 +08:00
"href": "./start.html"
2017-07-28 21:15:35 +08:00
},{
"name": "Github",
2017-07-28 23:31:35 +08:00
"href": "https://github.com/YMFE/yapi"
2017-07-28 21:15:35 +08:00
}],
"intro": [{ // 首页的正文部分,数组项依次渲染,可重复使用
2017-07-28 23:31:35 +08:00
"title": "为API开发者设计的管理平台", // 介绍板块标题
"desc": "YApi让接口开发更简单高效让接口的管理更具可读性、可维护性让团队协作更合理。" // 介绍板块描述
2017-07-28 21:15:35 +08:00
},{
2017-07-28 23:31:35 +08:00
"title": "功能",
2017-07-28 21:15:35 +08:00
"detail": {
"type": "thumbnail", // 三列布局的介绍板块
"content": [{ // 三列布局的内容每项的key值非必需但建议每列的key值一致
2017-08-24 16:37:45 +08:00
"name": "项目管理", // 板块名称
2017-07-28 21:15:35 +08:00
"src": "http://ojk406wln.bkt.clouddn.com/intro_muti.png", // 缩略图
2017-08-24 17:12:55 +08:00
"desc": "YApi成熟的团队管理扁平化项目权限配置满足各类企业的需求" // 描述
2017-07-28 21:15:35 +08:00
},{
2017-08-24 16:37:45 +08:00
"name": "接口管理",
2017-07-28 21:15:35 +08:00
"src": "http://ojk406wln.bkt.clouddn.com/intro_md.png",
2017-08-24 16:37:45 +08:00
"desc": "友好的接口文档基于websocket的多人协作接口编辑功能和类postman测试工具让多人协作成倍提升开发效率"
2017-07-28 21:15:35 +08:00
},{
2017-08-24 16:37:45 +08:00
"name": "MockServer",
2017-07-28 21:15:35 +08:00
"src": "http://ojk406wln.bkt.clouddn.com/intro_theme.png",
2017-08-24 17:12:55 +08:00
"desc": "基于Mockjs使用简单功能强大"
2017-07-28 21:15:35 +08:00
}]
}
}]
},
2017-08-31 17:08:28 +08:00
"banner": {
2017-07-28 23:31:35 +08:00
"title": "YApi",
2017-08-24 16:37:45 +08:00
"description": "高效、易用、功能强大的api管理平台旨在为开发、产品、测试人员提供更优雅的接口管理服务。"
2017-07-28 21:15:35 +08:00
},
2017-08-31 17:08:28 +08:00
"content": "./doc/home.md"
2017-07-28 21:15:35 +08:00
},{
2017-08-31 17:08:28 +08:00
"name": "usage",
"title": "使用手册",
2017-08-31 11:55:24 +08:00
"banner": {
2017-07-28 23:31:35 +08:00
"title": "YApi",
2017-09-01 15:59:53 +08:00
"description": "高效、易用、功能强大的api管理平台旨在为开发、产品、测试人员提供更优雅的接口管理服务。"
2017-07-06 19:21:54 +08:00
},
2017-08-31 11:55:24 +08:00
"content": {
"sidebar": true,
"multi": true,
"index": "./doc/usage/getfamiliar.md",
"pages": [{
"name": "认识 YApi",
"content": "./doc/usage/getfamiliar.md"
}, {
"name": "创建第一个API",
"content": "./doc/usage/quickstart.md"
2017-09-01 15:59:53 +08:00
}
// , {
// "name": "接口配置",
// "content": "./doc/usage/interface.md"
// }
, {
2017-08-31 11:55:24 +08:00
"name": "使用mock功能",
"content": "./doc/usage/mock.md"
2017-09-01 15:59:53 +08:00
}
// , {
// "name": "使用测试集",
// "content": "./doc/usage/case.md"
// }, {
// "name": "成为组长",
// "content": "./doc/usage/leader.md"
// }, {
// "name": "权限列表",
// "content": "./doc/usage/authority.md"
// }
]
2017-08-31 11:55:24 +08:00
}
2017-08-31 17:08:28 +08:00
},
// {
// "name": "manage",
// "title": "管理学院",
// "banner": {
// "title": "管理学院",
// "description": "超级管理员、分组/项目组长的学院。"
// },
// "content": {
// "sidebar": true,
// "multi": true,
// "index": "./doc/manage/intro.md",
// "pages": [{
// "name": "介绍",
// "content": "./doc/manage/intro.md"
// }, {
// "name": "部署",
// "content": "./doc/manage/build.md"
// }, {
// "name": "超管职责",
// "content": "./doc/manage/admin.md"
// }, {
// "name": "版本升级",
// "content": "./doc/manage/update.md"
// }]
// }
// },
{
2017-07-06 19:21:54 +08:00
"name": "api",
2017-07-28 23:31:35 +08:00
"title": "",
2017-07-06 19:21:54 +08:00
"banner": {
"title": "api",
"description": "api文档"
},
"content": "./server/controllers/*.js",
"options": {
2017-08-31 17:08:28 +08:00
"type": "interface",
"source": true,
2017-08-11 16:16:16 +08:00
"categories":["group","user","project", "interface","follow"]
2017-07-06 19:21:54 +08:00
}
2017-08-21 21:18:29 +08:00
}],
"resources": {
2017-08-31 17:08:28 +08:00
"images": "./doc/images",
"styles": "./doc/styles"
2017-08-21 21:18:29 +08:00
}
2017-07-06 19:21:54 +08:00
}