diff --git a/doc/images/usage/index.png b/doc/images/usage/index.png index ef7a3bd2..aec3fb19 100644 Binary files a/doc/images/usage/index.png and b/doc/images/usage/index.png differ diff --git a/doc/images/usage/project.png b/doc/images/usage/project.png index 978e1af5..76c0c98d 100644 Binary files a/doc/images/usage/project.png and b/doc/images/usage/project.png differ diff --git a/doc/styles/theme.css b/doc/styles/theme.css index 59ba0714..d81dfed1 100644 --- a/doc/styles/theme.css +++ b/doc/styles/theme.css @@ -13,3 +13,18 @@ body, h1, h2, h3, h4, h5, h6 { display: block; margin: 24px 0; } + +.list-index { + padding: 6px; + background-color: #ff561b; + color: #fff; + font:italic bold 18px arial,sans-serif; + border-radius: 50%; + display: inline-block; + width: 2.2em; + height: 2.2em; + line-height: 1.6em; + margin-right: .6em; + text-align: center; + vertical-align: middle; +} diff --git a/doc/usage/getfamiliar.md b/doc/usage/getfamiliar.md index 23aca1a9..cee619cf 100644 --- a/doc/usage/getfamiliar.md +++ b/doc/usage/getfamiliar.md @@ -5,6 +5,7 @@ YApi 是高效、易用、功能强大的api管理平台。 ## 登录与注册 想要使用 YApi ，首先要拥有账号，目前支持注册账号登录与QSSO登录两种方式。 + ## 首页 @@ -13,13 +14,13 @@ YApi 是高效、易用、功能强大的api管理平台。 此时你作为新用户，没有任何分组与项目的权限，因此只能搜索、浏览 “公开项目” 的接口，如果在首页找不到任何项目，请联系管理员将你加入对应项目。 -1.首页头部展示了当前所在的位置、搜索框、新建项目、查看文档和用户信息。 +1首页头部展示了当前所在的位置、搜索框、新建项目、查看文档和用户信息。 -2.首页左侧展示分组信息，“分组”是“项目”的集合，只有超级管理员可以管理分组。 +2首页左侧展示分组信息，“分组”是“项目”的集合，只有超级管理员可以管理分组。 -3.首页右侧是分组下的项目和成员列表，点击左侧的某个分组，右侧会出现该分组下的项目和成员信息。 +3首页右侧是分组下的项目和成员列表，点击左侧的某个分组，右侧会出现该分组下的项目和成员信息。 -4.点击项目右上角的星星即可关注项目，关注的项目可以在“我的关注”页面查看。 +4点击项目右上角的星星即可关注项目，关注的项目可以在“我的关注”页面查看。 @@ -29,15 +30,15 @@ YApi 是高效、易用、功能强大的api管理平台。 此时你作为新用户，只能浏览接口信息，不可以编辑项目或接口，如果需要编辑，请联系管理员将你加入该项目。 -1.项目页左侧的 “接口列表” 展示了该项目下的所有接口，右侧默认显示该项目下所有接口的列表。 +1项目页左侧的 “接口列表” 展示了该项目下的所有接口，右侧默认显示该项目下所有接口的列表。 -2.点击左侧的某个接口，右侧会出现“预览”、“编辑”和“运行”。 +2点击左侧的某个接口，右侧会出现“预览”、“编辑”和“运行”。 -3.点击左侧的 “测试集合” 使用[./case.html](测试集)功能。 +3点击左侧的 “测试集合” 使用[测试集](./case.html)功能。 -4.点击二级导航的“设置”，项目组长即可编辑项目信息和管理成员列表。 +4点击二级导航的“设置”，项目组长即可编辑项目信息和管理成员列表。 -5.点击二级导航的“动态”，即可查看项目的操作日志。 +5点击二级导航的“动态”，即可查看项目的操作日志。 diff --git a/static/doc/api.html b/static/doc/api.html index 1d63ebad..3215e893 100644 --- a/static/doc/api.html +++ b/static/doc/api.html @@ -3875,7 +3875,7 @@

源码位置: - ./server/controllers/interface.js:423 + ./server/controllers/interface.js:425

@@ -4804,7 +4804,7 @@

源码位置: - ./server/controllers/interfaceCol.js:329 + ./server/controllers/interfaceCol.js:330

@@ -4878,7 +4878,7 @@

源码位置: - ./server/controllers/interfaceCol.js:370 + ./server/controllers/interfaceCol.js:371

@@ -4938,7 +4938,7 @@

源码位置: - ./server/controllers/interfaceCol.js:412 + ./server/controllers/interfaceCol.js:413

diff --git a/static/doc/images/usage/index.png b/static/doc/images/usage/index.png index ef7a3bd2..aec3fb19 100644 Binary files a/static/doc/images/usage/index.png and b/static/doc/images/usage/index.png differ diff --git a/static/doc/images/usage/project.png b/static/doc/images/usage/project.png index 978e1af5..76c0c98d 100644 Binary files a/static/doc/images/usage/project.png and b/static/doc/images/usage/project.png differ diff --git a/static/doc/static/server/controllers/interface.js.html b/static/doc/static/server/controllers/interface.js.html index 11eb1498..bbdc46a3 100644 --- a/static/doc/static/server/controllers/interface.js.html +++ b/static/doc/static/server/controllers/interface.js.html @@ -164,7 +164,6 @@ class interfaceController extends baseController { let result = await this.Model.save(data); - let project = await this.projectModel.getBaseInfo(params.project_id); this.catModel.get(params.catid).then((cate) => { let username = this.getUsername(); let title = `用户 "${username}" 为分类 "${cate.name}" 添加了接口 "${data.title}"` @@ -175,15 +174,16 @@ class interfaceController extends baseController { username: username, typeid: params.project_id }); - let interfaceUrl = `http://${ctx.request.host}/project/${params.project_id}/interface/api/${result._id}` - this.sendNotice(params.project_id, { - title: `${username} 新增了接口 ${data.title}`, - content: `

${username}新增了接口(${data.title})

-

项目名：${project.name}

-

修改用户: "${username}"

-

接口名: ${data.title}

-

接口路径: [${data.method}]${data.path}

` - }) + //let project = await this.projectModel.getBaseInfo(params.project_id); + // let interfaceUrl = `http://${ctx.request.host}/project/${params.project_id}/interface/api/${result._id}` + // this.sendNotice(params.project_id, { + // title: `${username} 新增了接口 ${data.title}`, + // content: `

${username}新增了接口(${data.title})

+ //

项目名：${project.name}

+ //

修改用户: "${username}"

+ //

接口名: ${data.title}

+ //

接口路径: [${data.method}]${data.path}

` + // }) }); ctx.body = yapi.commons.resReturn(result); @@ -321,7 +321,7 @@ class interfaceController extends baseController { let id = ctx.request.body.id; - params.message = params.message || '没有改动日志'; + params.message = params.message || ''; params.message = params.message.replace(/\n/g, "
") if (!id) { @@ -429,17 +429,19 @@ class interfaceController extends baseController { }); }); } - let project = await this.projectModel.getBaseInfo(interfaceData.project_id); - let interfaceUrl = `http://${ctx.request.host}/project/${interfaceData.project_id}/interface/api/${id}` - this.sendNotice(interfaceData.project_id, { - title: `${username} 更新了接口`, - content: `

${username}更新了接口(${data.title})

-

项目名：${project.name}

-

修改用户: ${username}

-

接口名: ${data.title}

-

接口路径: [${data.method}]${data.path}

-

详细改动日志: ${params.message}

` - }) + if (params.switch_notice === true) { + let project = await this.projectModel.getBaseInfo(interfaceData.project_id); + let interfaceUrl = `http://${ctx.request.host}/project/${interfaceData.project_id}/interface/api/${id}` + this.sendNotice(interfaceData.project_id, { + title: `${username} 更新了接口`, + content: `

${username}更新了接口(${data.title})

+

项目名：${project.name}

+

修改用户: ${username}

+

接口名: ${data.title}

+

接口路径: [${data.method}]${data.path}

+

详细改动日志: ${params.message}

` + }) + } ctx.body = yapi.commons.resReturn(result); } catch (e) { diff --git a/static/doc/static/server/controllers/interfaceCol.js.html b/static/doc/static/server/controllers/interfaceCol.js.html index bd9decfc..80e68594 100644 --- a/static/doc/static/server/controllers/interfaceCol.js.html +++ b/static/doc/static/server/controllers/interfaceCol.js.html @@ -328,12 +328,13 @@ class interfaceColController extends baseController{ result.method = data.method; result.req_body_type = data.req_body_type; result.req_headers = data.req_headers; - + result.res_body = data.res_body; + result.res_body_type = data.res_body_type; result.req_body_form = this.handleParamsValue(data.req_body_form, result.req_body_form) result.req_query = this.handleParamsValue(data.req_query, result.req_query) result.req_params = this.handleParamsValue(data.req_params, result.req_params) - + ctx.body = yapi.commons.resReturn(result); }catch(e){ ctx.body = yapi.commons.resReturn(null, 400, e.message) diff --git a/static/doc/styles/theme.css b/static/doc/styles/theme.css index 59ba0714..d81dfed1 100644 --- a/static/doc/styles/theme.css +++ b/static/doc/styles/theme.css @@ -13,3 +13,18 @@ body, h1, h2, h3, h4, h5, h6 { display: block; margin: 24px 0; } + +.list-index { + padding: 6px; + background-color: #ff561b; + color: #fff; + font:italic bold 18px arial,sans-serif; + border-radius: 50%; + display: inline-block; + width: 2.2em; + height: 2.2em; + line-height: 1.6em; + margin-right: .6em; + text-align: center; + vertical-align: middle; +} diff --git a/static/doc/usage-认识 YApi.html b/static/doc/usage-认识 YApi.html index f3695048..106ebfc3 100644 --- a/static/doc/usage-认识 YApi.html +++ b/static/doc/usage-认识 YApi.html @@ -142,22 +142,22 @@

YApi 是高效、易用、功能强大的api管理平台。

在开始使用 YApi 之前，我们先来熟悉一下 YApi 的网站结构，这将让你快速了解YApi。

-

登录与注册 #

想要使用 YApi ，首先要拥有账号，目前支持注册账号登录与QSSO登录两种方式。 -

+

登录与注册 #

想要使用 YApi ，首先要拥有账号，目前支持注册账号登录与QSSO登录两种方式。

+

首页 #

登录后进入首页，首页展示了分组与项目。

此时你作为新用户，没有任何分组与项目的权限，因此只能搜索、浏览 “公开项目” 的接口，如果在首页找不到任何项目，请联系管理员将你加入对应项目。

-

1.首页头部展示了当前所在的位置、搜索框、新建项目、查看文档和用户信息。

-

2.首页左侧展示分组信息，“分组”是“项目”的集合，只有超级管理员可以管理分组。

-

3.首页右侧是分组下的项目和成员列表，点击左侧的某个分组，右侧会出现该分组下的项目和成员信息。

-

4.点击项目右上角的星星即可关注项目，关注的项目可以在“我的关注”页面查看。

+

1首页头部展示了当前所在的位置、搜索框、新建项目、查看文档和用户信息。

+

2首页左侧展示分组信息，“分组”是“项目”的集合，只有超级管理员可以管理分组。

+

3首页右侧是分组下的项目和成员列表，点击左侧的某个分组，右侧会出现该分组下的项目和成员信息。

+

4点击项目右上角的星星即可关注项目，关注的项目可以在“我的关注”页面查看。

项目页 #

点击一个项目，进入项目页，项目页展示了属于该项目的全部接口，并提供项目、接口的全部操作。

此时你作为新用户，只能浏览接口信息，不可以编辑项目或接口，如果需要编辑，请联系管理员将你加入该项目。

-

1.项目页左侧的 “接口列表” 展示了该项目下的所有接口，右侧默认显示该项目下所有接口的列表。

-

2.点击左侧的某个接口，右侧会出现“预览”、“编辑”和“运行”。

-

3.点击左侧的 “测试集合” 使用./case.html功能。

-

4.点击二级导航的“设置”，项目组长即可编辑项目信息和管理成员列表。

-

5.点击二级导航的“动态”，即可查看项目的操作日志。

+

1项目页左侧的 “接口列表” 展示了该项目下的所有接口，右侧默认显示该项目下所有接口的列表。

+

2点击左侧的某个接口，右侧会出现“预览”、“编辑”和“运行”。

+

3点击左侧的 “测试集合” 使用测试集功能。

+

4点击二级导航的“设置”，项目组长即可编辑项目信息和管理成员列表。

+

5点击二级导航的“动态”，即可查看项目的操作日志。

个人中心 #

鼠标移动到右上角的用户头像或用户名上，即可点击“个人中心”查看个人信息。

diff --git a/static/doc/usage.html b/static/doc/usage.html index 8af6ea61..a9e53292 100644 --- a/static/doc/usage.html +++ b/static/doc/usage.html @@ -122,22 +122,22 @@

YApi 是高效、易用、功能强大的api管理平台。

在开始使用 YApi 之前，我们先来熟悉一下 YApi 的网站结构，这将让你快速了解YApi。

-

登录与注册 #

想要使用 YApi ，首先要拥有账号，目前支持注册账号登录与QSSO登录两种方式。 -

+

登录与注册 #

想要使用 YApi ，首先要拥有账号，目前支持注册账号登录与QSSO登录两种方式。

+

首页 #

登录后进入首页，首页展示了分组与项目。

此时你作为新用户，没有任何分组与项目的权限，因此只能搜索、浏览 “公开项目” 的接口，如果在首页找不到任何项目，请联系管理员将你加入对应项目。

-

1.首页头部展示了当前所在的位置、搜索框、新建项目、查看文档和用户信息。

-

2.首页左侧展示分组信息，“分组”是“项目”的集合，只有超级管理员可以管理分组。

-

3.首页右侧是分组下的项目和成员列表，点击左侧的某个分组，右侧会出现该分组下的项目和成员信息。

-

4.点击项目右上角的星星即可关注项目，关注的项目可以在“我的关注”页面查看。

+

1首页头部展示了当前所在的位置、搜索框、新建项目、查看文档和用户信息。

+

2首页左侧展示分组信息，“分组”是“项目”的集合，只有超级管理员可以管理分组。

+

3首页右侧是分组下的项目和成员列表，点击左侧的某个分组，右侧会出现该分组下的项目和成员信息。

+

4点击项目右上角的星星即可关注项目，关注的项目可以在“我的关注”页面查看。

项目页 #

点击一个项目，进入项目页，项目页展示了属于该项目的全部接口，并提供项目、接口的全部操作。

此时你作为新用户，只能浏览接口信息，不可以编辑项目或接口，如果需要编辑，请联系管理员将你加入该项目。

-

1.项目页左侧的 “接口列表” 展示了该项目下的所有接口，右侧默认显示该项目下所有接口的列表。

-

2.点击左侧的某个接口，右侧会出现“预览”、“编辑”和“运行”。

-

3.点击左侧的 “测试集合” 使用./case.html功能。

-

4.点击二级导航的“设置”，项目组长即可编辑项目信息和管理成员列表。

-

5.点击二级导航的“动态”，即可查看项目的操作日志。

+

1项目页左侧的 “接口列表” 展示了该项目下的所有接口，右侧默认显示该项目下所有接口的列表。

+

2点击左侧的某个接口，右侧会出现“预览”、“编辑”和“运行”。

+

3点击左侧的 “测试集合” 使用测试集功能。

+

4点击二级导航的“设置”，项目组长即可编辑项目信息和管理成员列表。

+

5点击二级导航的“动态”，即可查看项目的操作日志。

个人中心 #

鼠标移动到右上角的用户头像或用户名上，即可点击“个人中心”查看个人信息。