docs: 接口部分文档

doc/page/usage/api.md

@@ -2,12 +2,23 @@
 
 ## 接口配置
 
-#### 4.3 接口编辑
+[新建接口](./usage-创建第一个API.html#新建_编辑接口) 后，点击新添加的接口，右侧可以看到接口的预览信息，点击右侧的 `编辑` Tab项进入编辑面板。
-添加完接口点击新添加的接口，跳转到接口预览页面，可看到刚才填写的信息。接口的详细信息点击编辑功能进行添加
 
-#### 4.4 测试接口
+在改面板中你可以看到接口的基本信息(接口名称、分类、路径)，除此以外，你还可以完善以下接口信息：
-点击运行tab,可进入到接口测试页面，首先安装chrome crossRequest扩展，才可正常使用此功能
+
-<img src="./images/interface_run.png" width="800"  style="margin:0px auto;display:block;" alt="图片名称" align=center />
+- 状态: 用于标识接口是否开发完成。
-点击保存按钮可把当前测试保存到测试集，方便下次调试
+- 接口描述: 用简短的文字描述接口的作用。
+- query: 接口url的查询字符串。
+- 请求 Headers: http 请求头字段。
+- 请求 Body: http 请求 body 部分。
+- 请求 Body: http 请求 body 部分。
+- 响应 Body: 模拟返回结果。
+> 响应 Body 分为 `json` & `raw` 两种形式
+
+- 是否开启邮件通知：开启后将此次接口的改动以邮件的形式发送至项目组所有成员。
 
 ## 接口调试
+
+<!-- 点击运行tab,可进入到接口测试页面，首先安装chrome crossRequest扩展，才可正常使用此功能
+<img src="./images/interface_run.png" width="800"  style="margin:0px auto;display:block;" alt="图片名称" align=center />
+点击保存按钮可把当前测试保存到测试集，方便下次调试 -->

doc/page/usage/project.md

@@ -28,9 +28,9 @@
 
 ### 配置环境
 
-点击项目图标，可以修改图标及背景色：
+`环境配置` 一项可以添加该项目下接口的实际环境，供 [接口测试](./usage-使用测试集.html) 使用。
 
-<img src="./images/usage/project_setting_logo.png" />
+<img src="./images/usage/project_setting_env.png" />
 
 ## 删除项目
 

static/doc/usage-接口操作.html

@@ -140,11 +140,19 @@
                     
                     <div class="content-right markdown-body use-sidebar" role="main">
 
-                         <h2 class="subject" id="介绍">介绍 <a class="hashlink" href="#介绍">#</a></h2><h2 class="subject" id="接口配置">接口配置 <a class="hashlink" href="#接口配置">#</a></h2><h4 class="subject" id="4.3_接口编辑">4.3 接口编辑 <a class="hashlink" href="#4.3_接口编辑">#</a></h4><p>添加完接口点击新添加的接口，跳转到接口预览页面，可看到刚才填写的信息。接口的详细信息点击编辑功能进行添加</p>
+                         <h2 class="subject" id="介绍">介绍 <a class="hashlink" href="#介绍">#</a></h2><h2 class="subject" id="接口配置">接口配置 <a class="hashlink" href="#接口配置">#</a></h2><p><a href="./usage-创建第一个API.html#新建_编辑接口">新建接口</a> 后，点击新添加的接口，右侧可以看到接口的预览信息，点击右侧的 <code>编辑</code> Tab项进入编辑面板。</p>
-<h4 class="subject" id="4.4_测试接口">4.4 测试接口 <a class="hashlink" href="#4.4_测试接口">#</a></h4><p>点击运行tab,可进入到接口测试页面，首先安装chrome crossRequest扩展，才可正常使用此功能
+<p>在改面板中你可以看到接口的基本信息(接口名称、分类、路径)，除此以外，你还可以完善以下接口信息：</p>
+<ul>
+<li>状态: 用于标识接口是否开发完成。</li><li>接口描述: 用简短的文字描述接口的作用。</li><li>query: 接口url的查询字符串。</li><li>请求 Headers: http 请求头字段。</li><li>请求 Body: http 请求 body 部分。</li><li>请求 Body: http 请求 body 部分。</li><li><p>响应 Body: 模拟返回结果。</p>
+<blockquote>
+<p>响应 Body 分为 <code>json</code> &amp; <code>raw</code> 两种形式</p>
+</blockquote>
+</li><li><p>是否开启邮件通知：开启后将此次接口的改动以邮件的形式发送至项目组所有成员。</p>
+</li></ul>
+<h2 class="subject" id="接口调试">接口调试 <a class="hashlink" href="#接口调试">#</a></h2><!-- 点击运行tab,可进入到接口测试页面，首先安装chrome crossRequest扩展，才可正常使用此功能
 <img src="./images/interface_run.png" width="800"  style="margin:0px auto;display:block;" alt="图片名称" align=center />
-点击保存按钮可把当前测试保存到测试集，方便下次调试</p>
+点击保存按钮可把当前测试保存到测试集，方便下次调试 -->
-<h2 class="subject" id="接口调试">接口调试 <a class="hashlink" href="#接口调试">#</a></h2>
+
                     </div>
                 </div>
                  

static/doc/usage-项目操作.html

@@ -109,6 +109,10 @@
                                     <li >
                                         <a href="#修改项目">修改项目</a>
                                     </li>
+                                     
+                                    <li >
+                                        <a href="#删除项目">删除项目</a>
+                                    </li>
                                 
                                 </ul>
                                             
@@ -149,8 +153,12 @@
 <p>这里比新建项目页面新增的功能如下：</p>
 <h3 class="subject" id="修改项目图标">修改项目图标 <a class="hashlink" href="#修改项目图标">#</a></h3><p>点击项目图标，可以修改图标及背景色：</p>
 <p><img src="./images/usage/project_setting_logo.png" /></p>
-<h3 class="subject" id="配置环境">配置环境 <a class="hashlink" href="#配置环境">#</a></h3><p>点击项目图标，可以修改图标及背景色：</p>
+<h3 class="subject" id="配置环境">配置环境 <a class="hashlink" href="#配置环境">#</a></h3><p><code>环境配置</code> 一项可以添加该项目下接口的实际环境，供 <a href="./usage-使用测试集.html">接口测试</a> 使用。</p>
-<p><img src="./images/usage/project_setting_logo.png" /></p>
+<p><img src="./images/usage/project_setting_env.png" /></p>
+<h2 class="subject" id="删除项目">删除项目 <a class="hashlink" href="#删除项目">#</a></h2><p>点击下方的删除按钮，输入项目名称进行删除。</p>
+<blockquote>
+<p>删除项目是高风险操作，因此 YApi 对这个操作进行了特别的约束。</p>
+</blockquote>
 
                     </div>
                 </div>