mirror of
https://github.com/YMFE/yapi.git
synced 2024-12-21 05:19:42 +08:00
101 lines
3.4 KiB
JSON
101 lines
3.4 KiB
JSON
{
|
||
"name": "YApi",
|
||
"dest": "static/doc",
|
||
"examplePath": "./exampleCode",
|
||
"defaultGrammar": "json",
|
||
"instructionsInfoPath": "", //使用说明 内容路径 (需要配合JS-Component注释的@instructions使用)
|
||
"instructionsUrlPath": "", //使用说明demo路径 (需要配合JS-Component注释的@instructions使用)
|
||
"common": { // 通用默认配置，包括主页配置等
|
||
"title": "YApi", //page title
|
||
"footer": "© 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": {
|
||
"foldcode": true,
|
||
"markdown": { // 对于 markdown 编译器进行统一配置
|
||
"menuLevel": 2 //选取第几级 head 作为目录，默认 -1 没有目录
|
||
}
|
||
},
|
||
"pages": [{
|
||
"name": "index",
|
||
"title": "使用手册",
|
||
"banner": {
|
||
"title": "YApi",
|
||
"description": "高效、易用、功能强大的api管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。"
|
||
},
|
||
"content": {
|
||
"sidebar": true,
|
||
"multi": true,
|
||
"index": "./doc/page/usage/getfamiliar.md",
|
||
"pages": [{
|
||
"name": "认识 YApi",
|
||
"content": "./doc/page/usage/getfamiliar.md"
|
||
},{
|
||
"name": "创建第一个API",
|
||
"content": "./doc/page/usage/quickstart.md"
|
||
},{
|
||
"name": "管理分组与项目",
|
||
"content": "./doc/page/usage/manage.md"
|
||
},{
|
||
"name": "项目操作",
|
||
"content": "./doc/page/usage/project.md"
|
||
},{
|
||
"name": "接口操作",
|
||
"content": "./doc/page/usage/api.md"
|
||
},{
|
||
"name": "使用mock功能",
|
||
"content": "./doc/page/usage/mock.md"
|
||
},{
|
||
"name": "使用测试集",
|
||
"content": "./doc/page/usage/case.md"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
// {
|
||
// "name": "manage",
|
||
// "title": "管理学院",
|
||
// "banner": {
|
||
// "title": "管理学院",
|
||
// "description": "超级管理员、分组/项目组长的学院。"
|
||
// },
|
||
// "content": {
|
||
// "sidebar": true,
|
||
// "multi": true,
|
||
// "index": "./doc/page/manage/intro.md",
|
||
// "pages": [{
|
||
// "name": "介绍",
|
||
// "content": "./doc/page/manage/intro.md"
|
||
// }, {
|
||
// "name": "部署",
|
||
// "content": "./doc/page/manage/build.md"
|
||
// }, {
|
||
// "name": "超管职责",
|
||
// "content": "./doc/page/manage/admin.md"
|
||
// }, {
|
||
// "name": "版本升级",
|
||
// "content": "./doc/page/manage/update.md"
|
||
// }]
|
||
// }
|
||
// },
|
||
{
|
||
"name": "api",
|
||
"title": "",
|
||
"banner": {
|
||
"title": "api",
|
||
"description": "api文档"
|
||
},
|
||
"content": "./server/controllers/*.js",
|
||
"options": {
|
||
"type": "interface",
|
||
"source": true,
|
||
"categories":["group","user","project", "interface","follow"]
|
||
}
|
||
}],
|
||
"resources": {
|
||
"images": "./doc/images",
|
||
"styles": "./doc/styles"
|
||
}
|
||
}
|