update readme

This commit is contained in:
oppofind 2019-09-23 22:06:33 +08:00
parent 5c43f96ff4
commit cd38219059
4 changed files with 6 additions and 11 deletions

View File

@ -20,7 +20,7 @@ smart-doc使用和测试可参考[smart-doc demo](https://github.com/shalousun/a
``` ```
# git clone https://github.com/shalousun/api-doc-test.git # git clone https://github.com/shalousun/api-doc-test.git
``` ```
你可以启动这个Spring Boot的项目然后访问`http://localhost:8080/doc/api.html`来smart-doc生成的接口文档。 你可以启动这个Spring Boot的项目然后访问`http://localhost:8080/doc/api.html`来浏览smart-doc生成的接口文档。
### Maven dependency ### Maven dependency
``` ```
<dependency> <dependency>

View File

@ -20,7 +20,7 @@ smart-doc使用和测试可参考[smart-doc demo](https://github.com/shalousun/a
``` ```
# git clone https://github.com/shalousun/api-doc-test.git # git clone https://github.com/shalousun/api-doc-test.git
``` ```
你可以启动这个Spring Boot的项目然后访问`http://localhost:8080/doc/api.html`来smart-doc生成的接口文档。 你可以启动这个Spring Boot的项目然后访问`http://localhost:8080/doc/api.html`来浏览smart-doc生成的接口文档。
### Maven dependency ### Maven dependency
``` ```
<dependency> <dependency>
@ -115,6 +115,6 @@ public class ApiDocTest {
## Other reference ## Other reference
- [smart-doc功能使用介绍](https://my.oschina.net/u/1760791/blog/2250962) - [smart-doc功能使用介绍](https://my.oschina.net/u/1760791/blog/2250962)
## License ## License
smart-doc is under the Apache 2.0 license. Smart-doc is under the Apache 2.0 license. See the [LICENSE](https://github.com/shalousun/smart-doc/blob/master/license.txt) file for details.
## Contact ## Contact
QQ群 170651381 QQ群 170651381

View File

@ -4,14 +4,9 @@ import com.power.common.util.DateTimeUtil;
import com.power.doc.builder.ApiDocBuilder; import com.power.doc.builder.ApiDocBuilder;
import com.power.doc.model.ApiConfig; import com.power.doc.model.ApiConfig;
import com.power.doc.model.RevisionLog; import com.power.doc.model.RevisionLog;
import com.power.doc.model.SourcePath; import com.power.doc.model.SourceCodePath;
import com.power.doc.utils.DocUtil;
import org.junit.Test; import org.junit.Test;
import java.text.MessageFormat;
import java.util.LinkedHashMap;
import java.util.Map;
/** /**
* Description: * Description:
* ApiDoc测试 * ApiDoc测试
@ -45,7 +40,7 @@ public class ApiDocTest {
config.setOutPath("d:\\md2"); config.setOutPath("d:\\md2");
//不指定SourcePaths默认加载代码为项目src/main/java下的 //不指定SourcePaths默认加载代码为项目src/main/java下的
config.setSourcePaths( config.setSourcePaths(
SourcePath.path().setDesc("本项目代码").setPath("src/test/java") SourceCodePath.path().setDesc("本项目代码").setPath("src/test/java")
//SourcePath.path().setPath("F:\\Personal\\project\\smart\\src\\main\\java") //SourcePath.path().setPath("F:\\Personal\\project\\smart\\src\\main\\java")
//SourcePath.path().setDesc("加载项目外代码").setPath("E:\\ApplicationPower\\ApplicationPower\\Common-util\\src\\main\\java") //SourcePath.path().setDesc("加载项目外代码").setPath("E:\\ApplicationPower\\ApplicationPower\\Common-util\\src\\main\\java")
); );

View File

@ -6,7 +6,7 @@ import org.junit.Test;
/** /**
* Description: * Description:
* DocUtil单元测试 * DocUtil junit test
* *
* @author yu 2018/06/16. * @author yu 2018/06/16.
*/ */