change project info

YeDaxia · Aug 10, 2017 · 5bb564c · 5bb564c
1 parent 4e41bf2
commit 5bb564c
Show file tree

Hide file tree

Showing 7 changed files with 343 additions and 6 deletions.
diff --git a/JApiDocs/docs/apidoc.log b/JApiDocs/docs/apidoc.log
@@ -0,0 +1,12 @@
+八月 10, 2017 6:29:51 下午 io.github.yedaxia.apidocs.LogUtils info
+信息: find java src path : /Users/yeguozhong/Desktop/gitLibrary/JApiDocs/playDemo/app/
+八月 10, 2017 6:29:51 下午 io.github.yedaxia.apidocs.LogUtils info
+信息: found it a play framework project, tell us if we are wrong.
+八月 10, 2017 6:29:51 下午 io.github.yedaxia.apidocs.LogUtils info
+信息: generate api docs start...
+八月 10, 2017 6:29:51 下午 io.github.yedaxia.apidocs.LogUtils info
+信息: start to generate docs for controller file : UserApi.java
+八月 10, 2017 6:29:51 下午 io.github.yedaxia.apidocs.LogUtils info
+信息: success to generate docs for controller file : UserApi.java
+八月 10, 2017 6:29:51 下午 io.github.yedaxia.apidocs.LogUtils info
+信息: generate api docs done !!!
diff --git a/JApiDocs/docs/index.html b/JApiDocs/docs/index.html
@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="utf-8">
+<title>API列表</title>
+<script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js"></script>
+<script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js?lang=json&amp;skin=sunburst"></script>
+<link href="style.css" rel="stylesheet" /> 
+</head>
+<body>
+<div id="wmd-preview" class="wmd-preview">
+  <h1>API 列表:</h1>
+  <ul class="toc">
+  <li><a href="用户接口.html">用户接口</a></li>
+  </ul>
+</div>	
+</body>
+</html>
diff --git a/JApiDocs/docs/iosCodes/UserVO.html b/JApiDocs/docs/iosCodes/UserVO.html
@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="utf-8">
+<title>UserVO</title>
+<script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js"></script>
+<script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js?lang=java&amp;skin=sunburst"></script>
+<script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js?lang=m&amp;skin=sunburst"></script>
+</head>
+<body>
+<pre class="prettyprint">
+<xmp>
+#import <Foundation/Foundation>;
+
+@interface UserVO : NSObject
+
+//用户id
+@property (nonatomic, assign) NSString userId;
+//用户名
+@property (nonatomic, assign) NSString userName;
+//好友
+@property (nonatomic, strong) SimpleUser[] friends;
+//阅读图书
+@property (nonatomic, strong) BookVO[] readBooks;
+//是否关注
+@property (nonatomic, strong) BOOL isFollow;
+
+
+@end
+</xmp>
+</pre>
+
+<pre class="prettyprint">
+<xmp>
+#import <Foundation/Foundation>;
+
+@interface SimpleUser : NSObject
+
+//用户id
+@property (nonatomic, assign) NSString userId;
+//用户名
+@property (nonatomic, assign) NSString userName;
+
+
+@end
+</xmp>
+</pre>
+
+<pre class="prettyprint">
+<xmp>
+#import <Foundation/Foundation>;
+
+@interface BookVO : NSObject
+
+//图书id
+@property (nonatomic, assign) NSString bookId;
+//图书名称;
+@property (nonatomic, assign) NSString bookName;
+
+
+@end
+</xmp>
+</pre>
+
+
+</body>
+</html>
diff --git a/JApiDocs/docs/javaCodes/UserVO.html b/JApiDocs/docs/javaCodes/UserVO.html
@@ -0,0 +1,136 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="utf-8">
+<title>UserVO</title>
+<script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js"></script>
+<script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js?lang=java&amp;skin=sunburst"></script>
+<script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js?lang=m&amp;skin=sunburst"></script>
+</head>
+<body>
+<pre class="prettyprint lang-java">
+public class UserVO implements Serializable{
+
+    private String userId; //用户id
+    private String userName; //用户名
+    private SimpleUser[] friends; //好友
+    private BookVO[] readBooks; //阅读图书
+    private boolean isFollow; //是否关注
+
+    @JSONField(name="userId")
+    public String getUserId(){
+        return userId;
+    }
+
+    @JSONField(name="userId")
+    public void setUserId(String userId){
+        this.userId = userId;
+    }
+
+    @JSONField(name="userName")
+    public String getUserName(){
+        return userName;
+    }
+
+    @JSONField(name="userName")
+    public void setUserName(String userName){
+        this.userName = userName;
+    }
+
+    @JSONField(name="friends")
+    public SimpleUser[] getFriends(){
+        return friends;
+    }
+
+    @JSONField(name="friends")
+    public void setFriends(SimpleUser[] friends){
+        this.friends = friends;
+    }
+
+    @JSONField(name="readBooks")
+    public BookVO[] getReadBooks(){
+        return readBooks;
+    }
+
+    @JSONField(name="readBooks")
+    public void setReadBooks(BookVO[] readBooks){
+        this.readBooks = readBooks;
+    }
+
+    @JSONField(name="isFollow")
+    public boolean getIsFollow(){
+        return isFollow;
+    }
+
+    @JSONField(name="isFollow")
+    public void setIsFollow(boolean isFollow){
+        this.isFollow = isFollow;
+    }
+
+}
+</pre>
+
+
+<pre class="prettyprint lang-java">
+public class SimpleUser implements Serializable{
+
+    private String userId; //用户id
+    private String userName; //用户名
+
+    @JSONField(name="userId")
+    public String getUserId(){
+        return userId;
+    }
+
+    @JSONField(name="userId")
+    public void setUserId(String userId){
+        this.userId = userId;
+    }
+
+    @JSONField(name="userName")
+    public String getUserName(){
+        return userName;
+    }
+
+    @JSONField(name="userName")
+    public void setUserName(String userName){
+        this.userName = userName;
+    }
+
+}
+</pre>
+
+
+<pre class="prettyprint lang-java">
+public class BookVO implements Serializable{
+
+    private String bookId; //图书id
+    private String bookName; //图书名称;
+
+    @JSONField(name="bookId")
+    public String getBookId(){
+        return bookId;
+    }
+
+    @JSONField(name="bookId")
+    public void setBookId(String bookId){
+        this.bookId = bookId;
+    }
+
+    @JSONField(name="bookName")
+    public String getBookName(){
+        return bookName;
+    }
+
+    @JSONField(name="bookName")
+    public void setBookName(String bookName){
+        this.bookName = bookName;
+    }
+
+}
+</pre>
+
+
+
+</body>
+</html>
diff --git a/JApiDocs/docs/用户接口.html b/JApiDocs/docs/用户接口.html
@@ -0,0 +1,104 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="utf-8">
+<title>用户接口</title>
+<script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js"></script>
+<script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js?lang=json&amp;skin=sunburst"></script>
+<link href="style.css" rel="stylesheet" /> 
+</head>
+<body>
+<div id="wmd-preview" class="wmd-preview">
+<h1><a href="index.html">《首页</a> 用户接口:</h1>
+<ul class="toc">
+<li><a href="#用户列表">用户列表</a></li><li><a href="#用户信息">用户信息</a></li>
+</ul>
+<hr>
+<h2 id="用户列表">用户列表</h2>
+
+<pre class="prettyprint lang-json">
+method：get
+url: /api/v1/user/list
+</pre>
+
+<p><strong>参数列表</strong></p>
+
+<table>
+<tr>
+<th>参数名</th>
+<th>类型</th>
+<th>必需</th>
+<th>描述</th>
+</tr>
+<tr><td>page</td><td>int</td><td>false</td><td>页数</td></tr><tr><td>pageSize</td><td>int</td><td>false</td><td>每页条数</td></tr>
+</table>
+
+<p>返回结果: <a href="javaCodes/UserVO.html">Android Code</a> | <a href="iosCodes/UserVO.html">IOS Code</a></p>
+
+<pre class="prettyprint lang-json">
+[
+  {
+    "userId": "string //用户id",
+    "userName": "string //用户名",
+    "friends": [
+      {
+        "userId": "string //用户id",
+        "userName": "string //用户名"
+      }
+    ],
+    "readBooks": [
+      {
+        "bookId": "string //图书id",
+        "bookName": "string //图书名称;"
+      }
+    ],
+    "isFollow": "boolean //是否关注"
+  }
+]
+</pre>
+
+<hr><h2 id="用户信息">用户信息</h2>
+
+<pre class="prettyprint lang-json">
+method：get
+url: /api/v1/user/userInfo
+</pre>
+
+<p><strong>参数列表</strong></p>
+
+<table>
+<tr>
+<th>参数名</th>
+<th>类型</th>
+<th>必需</th>
+<th>描述</th>
+</tr>
+<tr><td>userId</td><td>string</td><td>true</td><td>用户id</td></tr>
+</table>
+
+<p>返回结果: <a href="javaCodes/UserVO.html">Android Code</a> | <a href="iosCodes/UserVO.html">IOS Code</a></p>
+
+<pre class="prettyprint lang-json">
+{
+  "userId": "string //用户id",
+  "userName": "string //用户名",
+  "friends": [
+    {
+      "userId": "string //用户id",
+      "userName": "string //用户名"
+    }
+  ],
+  "readBooks": [
+    {
+      "bookId": "string //图书id",
+      "bookName": "string //图书名称;"
+    }
+  ],
+  "isFollow": "boolean //是否关注"
+}
+</pre>
+
+<hr>
+</div>
+</body>
+</html>
diff --git a/library/src/test/java/Projects.java b/library/src/test/java/Projects.java
@@ -2,10 +2,10 @@
  * @author yeguozhong yedaxia.github.com
  */
 public class Projects {
-    public static String SpringProject = "/Users/yeguozhong/IdeaProjects/play-apidocs/springDemo/";
-    public static String PlayProject = "/Users/yeguozhong/IdeaProjects/play-apidocs/playDemo/";
-    public static String GenericProject = "/Users/yeguozhong/IdeaProjects/play-apidocs/genericDemo/";
-    public static String JFinalProject = "/Users/yeguozhong/IdeaProjects/play-apidocs/jfinalDemo";
+    public static String SpringProject = "/Users/yeguozhong/Desktop/gitLibrary/JApiDocs/springDemo/";
+    public static String PlayProject = "/Users/yeguozhong/Desktop/gitLibrary/JApiDocs/playDemo/";
+    public static String GenericProject = "/Users/yeguozhong/Desktop/gitLibrary/JApiDocs/genericDemo/";
+    public static String JFinalProject = "/Users/yeguozhong/Desktop/gitLibrary/JApiDocs/jfinalDemo";
 
-    public static String DocsPath = "/Users/yeguozhong/IdeaProjects/play-apidocs/docs";
+    public static String DocsPath = "/Users/yeguozhong/Desktop/gitLibrary/JApiDocs/JApiDocs/docs";
 }
diff --git a/settings.gradle b/settings.gradle
@@ -1,4 +1,4 @@
-rootProject.name = 'apidocs'
+rootProject.name = 'JApiDocs'
 include 'library'
 include 'playDemo'
 include 'springDemo'