wanjia950611
/
smart-doc
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

update readme

This commit is contained in:
oppofind 2020-07-03 15:07:48 +08:00
parent bba93b5060
commit 628303fc55
4 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -133,6 +133,9 @@ When you need to use smart-doc to generate more API document information, you ca
"className": "org.springframework.data.domain.Pageable", "className": "org.springframework.data.domain.Pageable",
"replacementClassName": "com.power.doc.model.PageRequestDto" //Use custom PageRequestDto instead of JPA Pageable for document rendering. "replacementClassName": "com.power.doc.model.PageRequestDto" //Use custom PageRequestDto instead of JPA Pageable for document rendering.
}], }],
"apiConstants": [{////Configure your own constant class, smart-doc automatically replaces with a specific value when parsing to a constant
"constantsClassName": "com.power.doc.constants.RequestParamConstant"
}],
  "requestHeaders": [// Set global request headers, no need to set   "requestHeaders": [// Set global request headers, no need to set
    {     {
      "name": "token",       "name": "token",

3
README_CN.md
View File

@ -140,6 +140,9 @@ smart-doc官方目前已经开发完成maven 插件和gradle，你可以根据
"className": "org.springframework.data.domain.Pageable", "className": "org.springframework.data.domain.Pageable",
"replacementClassName": "com.power.doc.model.PageRequestDto" //自定义的PageRequestDto替换Pageable做文档渲染 "replacementClassName": "com.power.doc.model.PageRequestDto" //自定义的PageRequestDto替换Pageable做文档渲染
}], }],
"apiConstants": [{//从1.8.9开始配置自己的常量类，smart-doc在解析到常量时自动替换为具体的值
"constantsClassName": "com.power.doc.constants.RequestParamConstant"
}],
"sourceCodePaths": [ //设置代码路径, 插件已经能够自动下载发布的源码包，没必要配置 "sourceCodePaths": [ //设置代码路径, 插件已经能够自动下载发布的源码包，没必要配置
{ {
"path": "src/main/java", "path": "src/main/java",

4
pom.xml
View File

@ -5,7 +5,7 @@
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>
<artifactId>smart-doc</artifactId> <artifactId>smart-doc</artifactId>
<packaging>jar</packaging> <packaging>jar</packaging>
<version>1.8.8</version> <version>1.8.9</version>
<name>smart-doc</name> <name>smart-doc</name>
<url>https://github.com/shalousun/smart-doc.git</url> <url>https://github.com/shalousun/smart-doc.git</url>
@ -59,7 +59,7 @@
<dependency> <dependency>
<groupId>com.github.shalousun</groupId> <groupId>com.github.shalousun</groupId>
<artifactId>common-util</artifactId> <artifactId>common-util</artifactId>
<version>1.9.5</version> <version>1.9.6</version>
</dependency> </dependency>
<!--markdown to html--> <!--markdown to html-->
<dependency> <dependency>

3
src/main/java/com/power/doc/handler/SpringMVCRequestMappingHandler.java
View File

@ -50,6 +50,7 @@ public class SpringMVCRequestMappingHandler {
* @param serverUrl server url * @param serverUrl server url
* @param controllerBaseUrl spring mvc controller base url * @param controllerBaseUrl spring mvc controller base url
* @param method JavaMethod * @param method JavaMethod
* @param constantsMap project constant container
* @return RequestMapping * @return RequestMapping
*/ */
public RequestMapping handle(String serverUrl, String controllerBaseUrl, JavaMethod method, Map<String, String> constantsMap) { public RequestMapping handle(String serverUrl, String controllerBaseUrl, JavaMethod method, Map<String, String> constantsMap) {
@ -113,9 +114,11 @@ public class SpringMVCRequestMappingHandler {
String value = entry.getValue(); String value = entry.getValue();
if (url.contains(key)) { if (url.contains(key)) {
url = url.replace(key, value); url = url.replace(key, value);
url = url.replace("+", "");
} }
if (shortUrl.contains(key)) { if (shortUrl.contains(key)) {
shortUrl = shortUrl.replace(key, value); shortUrl = shortUrl.replace(key, value);
shortUrl = shortUrl.replace("+", "");
} }
} }
return RequestMapping.builder().setMediaType(mediaType).setMethodType(methodType) return RequestMapping.builder().setMediaType(mediaType).setMethodType(methodType)