增加测试生成接口的文档和样例数据

ufologist · Apr 21, 2014 · cb4168d · cb4168d
1 parent cf77df1
commit cb4168d
Show file tree

Hide file tree

Showing 2 changed files with 80 additions and 0 deletions.
diff --git a/WebContent/demo/test-interface.json b/WebContent/demo/test-interface.json
@@ -0,0 +1,27 @@
+{
+  "body": {
+    "users": [
+      {
+        "address": "@area @region",
+        "lastLoginIp": "@ip",
+        "bio": "@paragraph",
+        "email": "@email",
+        "profiles": "@url",
+        "sex": [
+          "男",
+          "女"
+        ],
+        "birthday": "@date(yyyy-MM)",
+        "lastLogin": "@datetime",
+        "vip": "@boolean",
+        "avatar": "@image",
+        "id": "@natural",
+        "name": "@name"
+      }
+    ]
+  },
+  "head": {
+    "timestamp": "@natural(1390000000000, 1400000000000)",
+    "version": "0.1.0"
+  }
+}
diff --git a/WebContent/demo/导出的接口文档.doc b/WebContent/demo/导出的接口文档.doc
@@ -0,0 +1,53 @@
+<!doctype html>
+<html>
+    <head>
+        <meta http-equiv="Content-Type" content="text/html;charset=UTF8">
+        <title></title>
+        <style type="text/css">
+            #container {margin:8px;}
+            .param-table {background:#E6E6E6;border:1px solid #FFF;margin:12px 0;border-collapse:collapse;}
+            .param-table th {background:gray;color:#FFF;font-size:14px;font-weight:bold;text-align:center;border:1px solid #FFF;}
+            .param-table td {border-collapse:collapse;border:1px solid #FFF;font-size:12px;}
+            .param-table .th-name {width:140px;}
+            .param-table .th-identifier {width:140px;}
+            .param-table .th-type {width:100px;}
+            .param-table .th-remark {width:200px;}
+            .param-table .td-name {}
+            .param-table .td-identifier {}
+            .param-table .td-type {color:#990000;}
+            .param-table .td-remark {color:#666;}
+            .param-table .tr-level-1 {background:#E6E6E6;}
+            .param-table .tr-level-2 {background:silver;}
+            .param-table .tr-level-3 {background:gray;}
+            .param-table .tr-level-4 {background:silver;}
+            .param-table .tr-level-5 {background:gray;}
+            .param-table .tr-level-6 {background:silver;}
+            .param-table .tr-level-7 {background:gray;}
+            .param-table .tr-level-8 {background:silver;}
+            .param-table .tr-level-9 {background:gray;}
+            .param-table .tr-level-10 {background:silver;}
+            .param-table .tr-level-11 {background:gray;}
+            .param-table .tr-level-12 {background:silver;}
+            .param-table .tr-level-13 {background:gray;}
+        </style>
+    </head>
+    <body>
+        <div id="container">
+                    <div class="module">
+                <h1>1&nbsp;首页模块</h1>
+                                    <div class="page">
+                        <h2>1.1&nbsp;首页</h2>
+                                                    <div class="action">
+                            <h3>1.1.1&nbsp;用户列表</h3>
+                            <h3>Description</h3>
+                            <div></div>
+                            <h3>Request Param List</h3>
+                            <table class="param-table"><thead><th class="th-name">Name</th><th class="th-identifier">Identifier</th><th class="th-type">Type</th><th class="th-remark">Remark</th></thead><tr class="tr-level-1"><td class="td-name">复杂参数</td><td class="td-identifier">testparam</td><td class="td-type">object</td><td class="td-remark"></td></tr><tr class="tr-level-2"><td class="td-name">---参数2</td><td class="td-identifier">p2</td><td class="td-type">string</td><td class="td-remark"></td></tr><tr class="tr-level-2"><td class="td-name">---参数1</td><td class="td-identifier">p1</td><td class="td-type">string</td><td class="td-remark"></td></tr><tr class="tr-level-1"><td class="td-name">密码</td><td class="td-identifier">password</td><td class="td-type">string</td><td class="td-remark"></td></tr><tr class="tr-level-1"><td class="td-name">用户ID</td><td class="td-identifier">id</td><td class="td-type">string</td><td class="td-remark"></td></tr></table>
+                            <h3>Response Param List</h3>
+                            <table class="param-table"><thead><th class="th-name">Name</th><th class="th-identifier">Identifier</th><th class="th-type">Type</th><th class="th-remark">Remark</th></thead><tr class="tr-level-1"><td class="td-name">消息头</td><td class="td-identifier">head</td><td class="td-type">object</td><td class="td-remark"></td></tr><tr class="tr-level-2"><td class="td-name">---版本号</td><td class="td-identifier">version</td><td class="td-type">string</td><td class="td-remark">@mock=0.1.0</td></tr><tr class="tr-level-2"><td class="td-name">---时间戳</td><td class="td-identifier">timestamp</td><td class="td-type">number</td><td class="td-remark">@mock=&quot;@natural(1390000000000, 1400000000000)&quot;</td></tr><tr class="tr-level-1"><td class="td-name">信息体</td><td class="td-identifier">body</td><td class="td-type">object</td><td class="td-remark"></td></tr><tr class="tr-level-2"><td class="td-name">---用户列表</td><td class="td-identifier">users|1-10</td><td class="td-type">array&lt;object&gt;</td><td class="td-remark"></td></tr><tr class="tr-level-3"><td class="td-name">------地址</td><td class="td-identifier">address</td><td class="td-type">string</td><td class="td-remark">@mock=@area @region</td></tr><tr class="tr-level-3"><td class="td-name">------电子邮件</td><td class="td-identifier">email</td><td class="td-type">string</td><td class="td-remark">@mock=@email</td></tr><tr class="tr-level-3"><td class="td-name">------姓名</td><td class="td-identifier">name</td><td class="td-type">string</td><td class="td-remark">@mock=@name</td></tr><tr class="tr-level-3"><td class="td-name">------最后登录IP</td><td class="td-identifier">lastLoginIp</td><td class="td-type">string</td><td class="td-remark">@mock=@ip</td></tr><tr class="tr-level-3"><td class="td-name">------最后登录时间</td><td class="td-identifier">lastLogin</td><td class="td-type">string</td><td class="td-remark">@mock=@datetime</td></tr><tr class="tr-level-3"><td class="td-name">------简介</td><td class="td-identifier">bio</td><td class="td-type">string</td><td class="td-remark">@mock=@paragraph</td></tr><tr class="tr-level-3"><td class="td-name">------头像</td><td class="td-identifier">avatar</td><td class="td-type">string</td><td class="td-remark">@mock=@image</td></tr><tr class="tr-level-3"><td class="td-name">------用户ID</td><td class="td-identifier">id</td><td class="td-type">number</td><td class="td-remark">@mock=&quot;@natural&quot;</td></tr><tr class="tr-level-3"><td class="td-name">------生日</td><td class="td-identifier">birthday</td><td class="td-type">string</td><td class="td-remark">@mock=@date(yyyy-MM)</td></tr><tr class="tr-level-3"><td class="td-name">------VIP否</td><td class="td-identifier">vip</td><td class="td-type">boolean</td><td class="td-remark">@mock=&quot;@boolean&quot;</td></tr><tr class="tr-level-3"><td class="td-name">------主页</td><td class="td-identifier">profiles</td><td class="td-type">string</td><td class="td-remark">@mock=@url</td></tr><tr class="tr-level-3"><td class="td-name">------性别</td><td class="td-identifier">sex|1</td><td class="td-type">string</td><td class="td-remark">@mock=[&#39;男&#39;, &#39;女&#39;]</td></tr></table>
+                            </div>
+                                            </div>
+                            </div>
+                </div>
+    </body>
+</html>