diff --git a/doc/images/project_add.png b/doc/images/project_add.png deleted file mode 100644 index 96f0232e..00000000 Binary files a/doc/images/project_add.png and /dev/null differ diff --git a/doc/images/usage/project_add.png b/doc/images/usage/project_add.png new file mode 100644 index 00000000..527bace4 Binary files /dev/null and b/doc/images/usage/project_add.png differ diff --git a/doc/images/usage/project_add_panel.png b/doc/images/usage/project_add_panel.png new file mode 100644 index 00000000..95bcacbd Binary files /dev/null and b/doc/images/usage/project_add_panel.png differ diff --git a/doc/images/usage/project_setting.png b/doc/images/usage/project_setting.png new file mode 100644 index 00000000..86156078 Binary files /dev/null and b/doc/images/usage/project_setting.png differ diff --git a/doc/images/usage/project_setting_env.png b/doc/images/usage/project_setting_env.png new file mode 100644 index 00000000..d34ce443 Binary files /dev/null and b/doc/images/usage/project_setting_env.png differ diff --git a/doc/images/usage/project_setting_logo.png b/doc/images/usage/project_setting_logo.png new file mode 100644 index 00000000..96994136 Binary files /dev/null and b/doc/images/usage/project_setting_logo.png differ diff --git a/doc/page/usage/api.md b/doc/page/usage/api.md index 857d180e..9b755f27 100644 --- a/doc/page/usage/api.md +++ b/doc/page/usage/api.md @@ -2,12 +2,23 @@ ## 接口配置 -#### 4.3 接口编辑 -添加完接口点击新添加的接口,跳转到接口预览页面,可看到刚才填写的信息。接口的详细信息点击编辑功能进行添加 +[新建接口](./usage-创建第一个API.html#新建_编辑接口) 后,点击新添加的接口,右侧可以看到接口的预览信息,点击右侧的 `编辑` Tab项进入编辑面板。 -#### 4.4 测试接口 -点击运行tab,可进入到接口测试页面,首先安装chrome crossRequest扩展,才可正常使用此功能 -图片名称 -点击保存按钮可把当前测试保存到测试集,方便下次调试 +在改面板中你可以看到接口的基本信息(接口名称、分类、路径),除此以外,你还可以完善以下接口信息: + +- 状态: 用于标识接口是否开发完成。 +- 接口描述: 用简短的文字描述接口的作用。 +- query: 接口url的查询字符串。 +- 请求 Headers: http 请求头字段。 +- 请求 Body: http 请求 body 部分。 +- 请求 Body: http 请求 body 部分。 +- 响应 Body: 模拟返回结果。 +> 响应 Body 分为 `json` & `raw` 两种形式 + +- 是否开启邮件通知:开启后将此次接口的改动以邮件的形式发送至项目组所有成员。 ## 接口调试 + + diff --git a/doc/page/usage/project.md b/doc/page/usage/project.md index 7af85c03..1a829e7c 100644 --- a/doc/page/usage/project.md +++ b/doc/page/usage/project.md @@ -1,3 +1,39 @@ ## 新建项目 +点击右上角的 `+` 新建项目,进入新建项目页面。 + + + +在新建项目页,填写项目信息: + +> - 项目名称不允许重复,包括其他分组 +> - 基本路径为接口统一添加了前缀 +> - 新建项目页只列出了部分配置,其他详细配置(环境配置、项目图标等)需要进入项目页的“设置”面板进行配置。 + + + ## 修改项目 + +在项目页点击上方的 `设置` Tab 进入项目设置面板,这个面板涵盖了项目的所有配置。 + + + +这里比新建项目页面新增的功能如下: + +### 修改项目图标 + +点击项目图标,可以修改图标及背景色: + + + +### 配置环境 + +`环境配置` 一项可以添加该项目下接口的实际环境,供 [接口测试](./usage-使用测试集.html) 使用。 + + + +## 删除项目 + +点击下方的删除按钮,输入项目名称进行删除。 + +> 删除项目是高风险操作,因此 YApi 对这个操作进行了特别的约束。 diff --git a/static/doc/images/project_add.png b/static/doc/images/project_add.png deleted file mode 100644 index 96f0232e..00000000 Binary files a/static/doc/images/project_add.png and /dev/null differ diff --git a/static/doc/images/usage/project_add.png b/static/doc/images/usage/project_add.png new file mode 100644 index 00000000..527bace4 Binary files /dev/null and b/static/doc/images/usage/project_add.png differ diff --git a/static/doc/images/usage/project_add_panel.png b/static/doc/images/usage/project_add_panel.png new file mode 100644 index 00000000..95bcacbd Binary files /dev/null and b/static/doc/images/usage/project_add_panel.png differ diff --git a/static/doc/images/usage/project_setting.png b/static/doc/images/usage/project_setting.png new file mode 100644 index 00000000..86156078 Binary files /dev/null and b/static/doc/images/usage/project_setting.png differ diff --git a/static/doc/images/usage/project_setting_env.png b/static/doc/images/usage/project_setting_env.png new file mode 100644 index 00000000..d34ce443 Binary files /dev/null and b/static/doc/images/usage/project_setting_env.png differ diff --git a/static/doc/images/usage/project_setting_logo.png b/static/doc/images/usage/project_setting_logo.png new file mode 100644 index 00000000..96994136 Binary files /dev/null and b/static/doc/images/usage/project_setting_logo.png differ diff --git a/static/doc/usage-使用mock功能.html b/static/doc/usage-使用mock功能.html index 64101063..08de58b4 100644 --- a/static/doc/usage-使用mock功能.html +++ b/static/doc/usage-使用mock功能.html @@ -91,13 +91,19 @@
  • - 项目管理 + 管理分组与项目
  • - 接口配置与调试 + 项目操作 +
  • + + +
  • + + 接口操作
  • diff --git a/static/doc/usage-使用测试集.html b/static/doc/usage-使用测试集.html index 6e9ff394..09c61f56 100644 --- a/static/doc/usage-使用测试集.html +++ b/static/doc/usage-使用测试集.html @@ -91,13 +91,19 @@
  • - 项目管理 + 管理分组与项目
  • - 接口配置与调试 + 项目操作 +
  • + + +
  • + + 接口操作
  • diff --git a/static/doc/usage-创建第一个API.html b/static/doc/usage-创建第一个API.html index f4c7d41c..062a31a5 100644 --- a/static/doc/usage-创建第一个API.html +++ b/static/doc/usage-创建第一个API.html @@ -107,13 +107,19 @@
  • - 项目管理 + 管理分组与项目
  • - 接口配置与调试 + 项目操作 +
  • + + +
  • + + 接口操作
  • diff --git a/static/doc/usage-接口配置与调试.html b/static/doc/usage-接口操作.html similarity index 83% rename from static/doc/usage-接口配置与调试.html rename to static/doc/usage-接口操作.html index 60479a7b..407d0e00 100644 --- a/static/doc/usage-接口配置与调试.html +++ b/static/doc/usage-接口操作.html @@ -91,13 +91,19 @@
  • - 项目管理 + 管理分组与项目 +
  • + + +
  • + + 项目操作
  • - 接口配置与调试 + 接口操作