net.html

@@ -99,7 +99,7 @@
     <span class="o">}</span>
 <span class="o">}</span></pre></div>
 
-            <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;继承HttpBaseServlet的子类可以使用其自带的鉴权、请求分支、缓存等功能， 一个典型的操作用户HttpServlet: </p> 
+            <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;继承HttpBaseServlet的子类可以使用其自带的鉴权、请求分支、缓存等功能， 一个典型的操作<span id="userservlet">用户HttpServlet</span>: </p> 
             <div class="highlight"><pre><span class="nd">@WebServlet</span><span class="o">(</span><span class="n">value</span> <span class="o">=</span> <span class="o">{</span><span class="s">&quot;/user/*&quot;</span><span class="o">},</span> <span class="n">comment</span> <span class="o">=</span> <span class="s">&quot;用户模块服务&quot;</span><span class="o">)</span>  <span class="c1">//拦截所有 /user/ 开头的请求</span>
 <span class="kd">public</span> <span class="kd">class</span> <span class="nc">UserServlet</span> <span class="kd">extends</span> <span class="n">BaseSerlvet</span> <span class="o">{</span>
 
@@ -166,6 +166,11 @@
             <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;如上, 配置了/pipes 前缀后，客户端发送Servlet请求需带上前缀，请求当前用户信息的url就变成：/pipes/user/myinfo 。</p>
             <br/>
 
+            <p id="net_apidoc">&nbsp;&nbsp;<b> API Doc</b> </p>
+            <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;在小型互联网公司里，基本是追求敏捷开发，很少先花时间设计接口文档再进行开发，通常都是直接进行数据库设计和开发，开发完后需要开发人员需要编写接口文档提供给前端人员开发。为了减少文档的编写工作量和强制开发人员对接口进行注释，Redkale提供了apidoc命令，apidoc遍历当前进程中所有标记@WebServlet的可用HttpServlet，根据Servlet中@WebAction、@WebParam生成json对象并输出文件。在<b>系统运行</b>时执行apidoc命令会在进程根目录下生成apidoc.json、apidoc.html文件。apidoc.html的模板可以定制， 只需在conf/目录下存放一个 <b>apidoc-template.html</b> 文件，且文件中必须包含关键字 <b>${content}</b> 即可实现接口文档的自定义。<br/>
+                &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;为了能正确显示接口文档，开发人员需要在编写HttpServlet时，在每个@WebAction方法上加上comment属性和@WebParam注解, 一个方法上可以注解多个@WebParam, 如上面的 <a href="#userservlet">UserServlet</a> 。RestHttpServlet是由RestService自动生成，@WebAction、@WebParam在REST组件中存在对应的注解@RestMapping、@RestParam，因此在编写RestService时需要加上@RestMapping、@RestParam且加上comment属性。如范例: <a href="service.html#helloservice" target="_blank">HelloService</a> 。<br/>
+            </p>
+
             <p id="net_ws">&nbsp;&nbsp;<b> WebSokcet 服务</b> </p>
             <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;WebSokcet协议遵循<a href="http://tools.ietf.org/html/rfc645" target="_blank">IETF RFC 6455</a>，其接口并不符合Java EE中的WebSocket的接口规范。<br/>
                 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;一个WebSocket连接对应一个WebSocket实体，即一个WebSocket会绑定一个TCP连接。且有两种模式:<br/>
@@ -488,7 +493,7 @@
     <span class="c1">//获取request创建时间</span>
     <span class="kd">public</span> <span class="kt">long</span> <span class="nf">getCreatetime</span><span class="o">();</span>
 <span class="o">}</span>
-</pre></div>
+                </pre></div>
 
 
             <p id="net_httpresponse">&nbsp;&nbsp;<b>. HttpResponse 对象</b> </p>
@@ -602,7 +607,7 @@
     <span class="c1">//HttpResponse回收时回调的监听方法</span>
     <span class="kd">public</span> <span class="kt">void</span> <span class="nf">setRecycleListener</span><span class="o">(</span><span class="n">BiConsumer</span><span class="o">&lt;</span><span class="n">HttpRequest</span><span class="o">,</span> <span class="n">HttpResponse</span><span class="o">&gt;</span> <span class="n">recycleListener</span><span class="o">);</span>
 <span class="o">}</span>
-</pre></div>
+                </pre></div>
 
 
             <p id="net_websocket">&nbsp;&nbsp;<b>. WebSocket 对象</b> </p>

service.html

@@ -489,7 +489,7 @@
 <span class="o">}</span>
                 </pre></div>
 
-            <div class="highlight"><pre><span></span><span class="cm">/**</span>
+            <div id="helloservice" class="highlight"><pre><span></span><span class="cm">/**</span>
 <span class="cm"> * 类说明:</span>
 <span class="cm"> * Flipper : Source组件中的翻页对象</span>
 <span class="cm"> * UserInfo ：当前用户类</span>