Merge pull request #51 from geekidea/dev

💻 1.2.3.RELEASE Java Api Docs

Author: springboot-plus

CHANGELOG.md

@@ -22,6 +22,7 @@
 
 ### 📔  Documentation
 [CentOS Quick Installation Environment / Build / Deploy / Launch Spring-boot-plus Project](https://github.com/geekidea/spring-boot-plus#centos-quick-installation-environment--build--deploy--launch-spring-boot-plus-project)
+[spring-boot-plus java docs](http://geekidea.io/spring-boot-plus-apidocs/)
 
 ### 🔨 Dependency Upgrades
 - Upgrade to `springboot` 2.1.8.RELEASE

README-zh.md

@@ -36,6 +36,9 @@
 ## CHANGELOG
 #### [CHANGELOG.md](https://github.com/geekidea/spring-boot-plus/blob/master/CHANGELOG.md)
 
+## Java Docs
+#### [Java Api Docs](http://geekidea.io/spring-boot-plus-apidocs/)
+
 ## 项目架构
 ![spring-boot-plus-architecture.jpg](https://raw.githubusercontent.com/geekidea/spring-boot-plus/master/docs/img/spring-boot-plus-architecture.jpg)
 

README.md

@@ -38,6 +38,9 @@
 ## CHANGELOG
 #### [CHANGELOG.md](https://github.com/geekidea/spring-boot-plus/blob/master/CHANGELOG.md)
 
+## Java Docs
+#### [Java Api Docs](http://geekidea.io/spring-boot-plus-apidocs/)
+
 ## Architecture
 ![spring-boot-plus-architecture.jpg](https://raw.githubusercontent.com/geekidea/spring-boot-plus/master/docs/img/spring-boot-plus-architecture.jpg)
 

pom.xml

@@ -42,8 +42,9 @@
     </developers>
 
     <properties>
-        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
+        <utf8>UTF-8</utf8>
+        <project.build.sourceEncoding>${utf8}</project.build.sourceEncoding>
+        <project.reporting.outputEncoding>${utf8}</project.reporting.outputEncoding>
         <project-parent.version>${parent.version}</project-parent.version>
         <java.version>1.8</java.version>
         <spring-boot.version>2.1.8.RELEASE</spring-boot.version>
@@ -69,6 +70,7 @@
         <maven-compiler-plugin.version>3.8.1</maven-compiler-plugin.version>
         <maven-resources-plugin.version>3.1.0</maven-resources-plugin.version>
         <maven-surefire-plugin.version>2.22.2</maven-surefire-plugin.version>
+        <maven-javadoc-plugin.version>3.1.1</maven-javadoc-plugin.version>
     </properties>
 
     <dependencyManagement>
@@ -357,6 +359,26 @@
                 </executions>
             </plugin>
 
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <version>${maven-javadoc-plugin.version}</version>
+                <configuration>
+                    <additionalOptions>
+                        <additionalOption>-Xdoclint:none</additionalOption>
+                    </additionalOptions>
+                </configuration>
+                <executions>
+                    <execution>
+                        <id>attach-javadocs</id>
+                        <goals>
+                            <goal>jar</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+
+
         </plugins>
 
     </build>

src/main/java/io/geekidea/springbootplus/common/constant/CommonRedisKey.java

@@ -20,7 +20,7 @@
  * <p>
  *  redis key 常量
  * </p>
- * @auth geekidea
+ * @author geekidea
  * @date 2019-05-23
  **/
 public interface CommonRedisKey {

src/main/java/io/geekidea/springbootplus/security/config/JwtProperties.java

@@ -24,7 +24,7 @@
  * <p>
  *  Jwt配置属性
  * </p>
- * @auth geekidea
+ * @author geekidea
  * @date 2019-05-22
  **/
 @Data

src/main/java/io/geekidea/springbootplus/security/controller/LoginController.java

@@ -30,7 +30,7 @@
  * <p>
  *
  * </p>
- * @auth geekidea
+ * @author geekidea
  * @date 2019-05-15
  **/
 @Slf4j

src/main/java/io/geekidea/springbootplus/security/interceptor/JwtInterceptor.java

@@ -37,7 +37,7 @@
  * <p>
  *  判断jwt token是否有效
  * </p>
- * @auth geekidea
+ * @author geekidea
  * @date 2019-05-22
  **/
 @Slf4j

src/main/java/io/geekidea/springbootplus/security/param/LoginParam.java

@@ -26,7 +26,7 @@
  * <p>
  *  登录参数
  * </p>
- * @auth geekidea
+ * @author geekidea
  * @date 2019-05-15
  **/
 @Data

src/main/java/io/geekidea/springbootplus/security/service/LoginService.java

@@ -27,7 +27,7 @@
  * <p>
  *  登录服务接口
  * </p>
- * @auth geekidea
+ * @author geekidea
  * @date 2019-05-23
  **/
 public interface LoginService {

src/main/java/io/geekidea/springbootplus/security/service/impl/LoginServiceImpl.java

@@ -51,7 +51,7 @@
  * <p>
  *  登录服务实现类
  * </p>
- * @auth geekidea
+ * @author geekidea
  * @date 2019-05-23
  **/
 @Api

src/main/java/io/geekidea/springbootplus/security/util/JwtUtil.java

@@ -34,7 +34,7 @@
  * <p>
  *  jwt工具类
  * </p>
- * @auth geekidea
+ * @author geekidea
  * @date 2019-05-15
  **/
 @Slf4j

src/main/java/io/geekidea/springbootplus/security/vo/ClientInfo.java

@@ -24,7 +24,7 @@
  * <p>
  *  用户客户端信息对象
  * </p>
- * @auth geekidea
+ * @author geekidea
  * @date 2019-05-23
  **/
 @Data

src/main/java/io/geekidea/springbootplus/security/vo/DeviceInfo.java

@@ -24,7 +24,7 @@
  * <p>
  *  设备信息
  * </p>
- * @auth geekidea
+ * @author geekidea
  * @date 2019-05-24
  **/
 @Data

src/main/java/io/geekidea/springbootplus/security/vo/JwtTokenRedisVo.java

@@ -25,7 +25,7 @@
  * <p>
  *
  * </p>
- * @auth geekidea
+ * @author geekidea
  * @date 2019-05-23
  **/
 @Data

src/main/java/io/geekidea/springbootplus/security/vo/LoginSysUserRedisVo.java

@@ -25,7 +25,7 @@
  * <p>
  *  登录用户redis对象，后台使用
  * </p>
- * @auth geekidea
+ * @author geekidea
  * @date 2019-05-15
  **/
 @Data

src/main/java/io/geekidea/springbootplus/security/vo/LoginSysUserVo.java

@@ -24,7 +24,7 @@
  * <p>
  *  登录用户对象，响应给前端
  * </p>
- * @auth geekidea
+ * @author geekidea
  * @date 2019-05-15
  **/
 @Data

src/main/java/io/geekidea/springbootplus/util/ClientInfoUtil.java

@@ -28,7 +28,7 @@
  * <p>
  *  用户客户端信息工具类
  * </p>
- * @auth geekidea
+ * @author geekidea
  * @date 2019-05-24
  **/
 public class ClientInfoUtil {

src/main/java/io/geekidea/springbootplus/util/MapUtil.java

@@ -23,7 +23,7 @@
  * <p>
  *  Map构建工具类
  * </p>
- * @auth geekidea
+ * @author geekidea
  * @date 2019-05-23
  **/
 public class MapUtil {

src/main/java/io/geekidea/springbootplus/util/PrintApplicationInfo.java

@@ -25,7 +25,7 @@
  * <p>
  *  打印项目信息
  * </p>
- * @auth geekidea
+ * @author geekidea
  * @date 2019-05-08
  **/
 @Slf4j