update template
This commit is contained in:
oppofind
parent
ecf5fee454
commit
4a24be44ce
|
|
@ -1,7 +1,11 @@
|
|||
## smart-doc版本
|
||||
版本小于1.0都属于试用，正式1.0起始发布将会等到文中提到的问题解决后才发布。
|
||||
#### 版本号：2.0.2
|
||||
- 更新日期: 2021-01-01
|
||||
- 更新日期: 2020-01-04
|
||||
- 更新内容：
|
||||
1. 修改页面的错误列表标题显示
|
||||
#### 版本号：2.0.2
|
||||
- 更新日期: 2020-02-27
|
||||
- 更新内容：
|
||||
1. 修改创建openapi时的空指针异常。
|
||||
2. 修改debug页面时未使用mock值的问题。
|
||||
|
|
|
|||
|
|
@ -97,6 +97,7 @@ When you need to use smart-doc to generate more API document information, you ca
|
|||
"skipTransientField": true, // Not currently implemented
|
||||
"style":"xt256", //set highlight
|
||||
"createDebugPage": true,
|
||||
"language":"ENGLISH",//support ENGLISH and CHINESE
|
||||
"sortByTitle":false,//Sort by interface title, the default value is false
|
||||
"requestFieldToUnderline":true, //convert request field to underline
|
||||
"inlineEnum":true,// Set to true to display enumeration details in the parameter table
|
||||
|
|
|
|||
BIN
screen/1.png
BIN
screen/1.png
Binary file not shown.
|
Before Width: | Height: | Size: 153 KiB |
BIN
screen/2.png
BIN
screen/2.png
Binary file not shown.
|
Before Width: | Height: | Size: 207 KiB |
BIN
screen/3.png
BIN
screen/3.png
Binary file not shown.
|
Before Width: | Height: | Size: 187 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 205 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 88 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 103 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 139 KiB |
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -1,4 +1,4 @@
|
|||
<!DOCTYPE html><html lang="en"><head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="smart-doc"><title>SpringBoot2-Open-Api</title><link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"><link rel="stylesheet" href="AllInOne.css?v=1607962934038"/><link rel="stylesheet" href="https://cdn.bootcdn.net/ajax/libs/highlight.js/10.3.2/styles/xt256.min.css"><style> .literalblock pre, .listingblock pre:not(.highlight), .listingblock pre[class="highlight"], .listingblock pre[class^="highlight "], .listingblock pre.CodeRay, .listingblock pre.prettyprint { background: #000; } .hljs { padding: 0em; }</style><script src="https://cdn.bootcdn.net/ajax/libs/highlight.js/10.3.2/highlight.min.js"></script><script src="https://cdn.bootcss.com/jquery/2.2.4/jquery.min.js"></script></head><body class="book toc2 toc-left"><div id="header"><%if(isNotEmpty(projectName)){%><h1>${projectName}</h1><%}%><div id="toc" class="toc2"><div id="book-search-input"><input id="search" type="text" placeholder="Type to search"></div><div id="toctitle"><span>API Reference</span></div><ul id="accordion" class="sectlevel1"><%for(api in apiDocList){%><%if(apiLP.first){%><li><a class="dd" href="${alias}.html#header">${api.order}. ${api.desc}</a><ul class="sectlevel2" style="display: none"><%for(doc in api.list){%><li><%if(doc.deprecated){%><a href="${alias}.html#_${api.order}_${doc.order}_${doc.desc}">${api.order}.${doc.order}. <span class="line-through">${doc.desc}</span></a><%}else{%><a href="${alias}.html#_${api.order}_${doc.order}_${doc.desc}">${api.order}.${doc.order}. ${doc.desc}</a><%}%></li><%}%></ul></li><%}else{%><li><a class="dd" href="${api.alias}.html#header">${api.order}. ${api.desc}</a><ul class="sectlevel2" style="display: none"><%for(doc in api.list){%><li><%if(doc.deprecated){%><a href="${api.alias}.html#_${api.order}_${doc.order}_${doc.desc}">${api.order}.${doc.order}. <span class="line-through">${doc.desc}</span></a><%}else{%><a href="${api.alias}.html#_${api.order}_${doc.order}_${doc.desc}">${api.order}.${doc.order}. ${doc.desc}</a><%}%></li><%}%></ul></li><%}%><%}%><%if(isNotEmpty(errorCodeList)){%><li><a href="error.html#_error_code_list">${apiDocList.~size+1}.${errorListTitle}</a></li><%}%><%if(isNotEmpty(dictList)){%><li class="open"><a class="dd" href="dict.html#_dict_list">${dictListOrder}. ${dictListTitle}</a><ul class="sectlevel2" style="display: block"><%for(dict in dictList){%><li><a href="dict.html#_${dictListOrder}_${dict.order}_${dict.title}">${dictListOrder}.${dict.order}. ${dict.title}</a></li><%}%></ul></li><%}%></ul></div></div><div id="content"><%if(isNotEmpty(dictList)){%><div class="sect1"><h2 id="_dict_list"><a class="anchor" href="#_dict_list"></a><a class="link" href="#_dict_list">${dictListOrder}. ${dictListTitle}</a></h2><div class="sectionbody"><% for(dict in dictList){ %><div class="sect2"><h3 id="_${dictListOrder}_${dict.order}_${dict.title}"><a class="anchor" href="#_${dictListOrder}_${dict.order}_${dict.title}"></a><a class="link" href="#_${dictListOrder}_${dict.order}_${dict.title}">${dictListOrder}.${dict.order}. ${dict.title}</a></h3><table class="tableblock frame-all grid-all spread"><colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup><thead><tr><th class="tableblock halign-left valign-top">Code</th><th class="tableblock halign-left valign-top">Type</th><th class="tableblock halign-left valign-top">Description</th></tr></thead><tbody><%for(dataDict in dict.dataDictList){%><tr><td class="tableblock halign-left valign-top"><p class="tableblock">${dataDict.value}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">${dataDict.type}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">${dataDict.desc}</p></td></tr><%}%></tbody></table></div><%}%></div></div><%}%><footer class="page-footer"><span class="copyright">Generated by smart-doc at ${createTime}</span><span class="footer-modification">Suggestions,contact,support and error reporting on<a href="https://gitee.com/smart-doc-team/smart-doc" target="_blank"> Gitee</a> or<a href="https://github.com/smart-doc-group/smart-doc.git" target="_blank"> Github</a></span></footer></div>
|
||||
<!DOCTYPE html><html lang="en"><head><meta charset="UTF-8"><meta name="viewport"content="width=device-width, initial-scale=1.0"><meta name="generator"content="smart-doc"><title>SpringBoot2-Open-Api</title><link rel="stylesheet"href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"><link rel="stylesheet"href="AllInOne.css?v=1607962934038"/><link rel="stylesheet"href="https://cdn.bootcdn.net/ajax/libs/highlight.js/10.3.2/styles/xt256.min.css"><style>.literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#000}.hljs{padding:0em}</style><script src="https://cdn.bootcdn.net/ajax/libs/highlight.js/10.3.2/highlight.min.js"></script><script src="https://cdn.bootcss.com/jquery/2.2.4/jquery.min.js"></script></head><body class="book toc2 toc-left"><div id="header"><%if(isNotEmpty(projectName)){%><h1>${projectName}</h1><%}%><div id="toc"class="toc2"><div id="book-search-input"><input id="search"type="text"placeholder="Type to search"></div><div id="toctitle"><span>API Reference</span></div><ul id="accordion"class="sectlevel1"><%for(api in apiDocList){%><%if(apiLP.first){%><li><a class="dd"href="${alias}.html#header">${api.order}. ${api.desc}</a><ul class="sectlevel2"style="display: none"><%for(doc in api.list){%><li><%if(doc.deprecated){%><a href="${alias}.html#_${api.order}_${doc.order}_${doc.desc}">${api.order}.${doc.order}. <span class="line-through">${doc.desc}</span></a><%}else{%><a href="${alias}.html#_${api.order}_${doc.order}_${doc.desc}">${api.order}.${doc.order}. ${doc.desc}</a><%}%></li><%}%></ul></li><%}else{%><li><a class="dd"href="${api.alias}.html#header">${api.order}. ${api.desc}</a><ul class="sectlevel2"style="display: none"><%for(doc in api.list){%><li><%if(doc.deprecated){%><a href="${api.alias}.html#_${api.order}_${doc.order}_${doc.desc}">${api.order}.${doc.order}. <span class="line-through">${doc.desc}</span></a><%}else{%><a href="${api.alias}.html#_${api.order}_${doc.order}_${doc.desc}">${api.order}.${doc.order}. ${doc.desc}</a><%}%></li><%}%></ul></li><%}%><%}%><%if(isNotEmpty(errorCodeList)){%><li><a href="error.html#_error_code_list">${apiDocList.~size+1}. ${errorListTitle}</a></li><%}%><%if(isNotEmpty(dictList)){%><li class="open"><a class="dd"href="dict.html#_dict_list">${dictListOrder}. ${dictListTitle}</a><ul class="sectlevel2"style="display: block"><%for(dict in dictList){%><li><a href="dict.html#_${dictListOrder}_${dict.order}_${dict.title}">${dictListOrder}.${dict.order}. ${dict.title}</a></li><%}%></ul></li><%}%></ul></div></div><div id="content"><%if(isNotEmpty(dictList)){%><div class="sect1"><h2 id="_dict_list"><a class="anchor"href="#_dict_list"></a><a class="link"href="#_dict_list">${dictListOrder}. ${dictListTitle}</a></h2><div class="sectionbody"><%for(dict in dictList){%><div class="sect2"><h3 id="_${dictListOrder}_${dict.order}_${dict.title}"><a class="anchor"href="#_${dictListOrder}_${dict.order}_${dict.title}"></a><a class="link"href="#_${dictListOrder}_${dict.order}_${dict.title}">${dictListOrder}.${dict.order}. ${dict.title}</a></h3><table class="tableblock frame-all grid-all spread"><colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup><thead><tr><th class="tableblock halign-left valign-top">Code</th><th class="tableblock halign-left valign-top">Type</th><th class="tableblock halign-left valign-top">Description</th></tr></thead><tbody><%for(dataDict in dict.dataDictList){%><tr><td class="tableblock halign-left valign-top"><p class="tableblock">${dataDict.value}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">${dataDict.type}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">${dataDict.desc}</p></td></tr><%}%></tbody></table></div><%}%></div></div><%}%><footer class="page-footer"><span class="copyright">Generated by smart-doc at ${createTime}</span><span class="footer-modification">Suggestions,contact,support and error reporting on<a href="https://gitee.com/smart-doc-team/smart-doc"target="_blank"> Gitee</a> or<a href="https://github.com/smart-doc-group/smart-doc.git"target="_blank"> Github</a></span></footer></div>
|
||||
<script src="search.js?v=${version}"></script>
|
||||
<script>
|
||||
$(function () {
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<!DOCTYPE html><html lang="en"><head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="smart-doc"><title>SpringBoot2-Open-Api</title><link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"><link rel="stylesheet" href="AllInOne.css?v=1607962934038"/><link rel="stylesheet" href="https://cdn.bootcdn.net/ajax/libs/highlight.js/10.3.2/styles/xt256.min.css"><style> .literalblock pre, .listingblock pre:not(.highlight), .listingblock pre[class="highlight"], .listingblock pre[class^="highlight "], .listingblock pre.CodeRay, .listingblock pre.prettyprint { background: #000; } .hljs { padding: 0em; }</style><script src="https://cdn.bootcdn.net/ajax/libs/highlight.js/10.3.2/highlight.min.js"></script><script src="https://cdn.bootcss.com/jquery/2.2.4/jquery.min.js"></script></head><body class="book toc2 toc-left"><div id="header"><%if(isNotEmpty(projectName)){%><h1>${projectName}</h1><%}%><div id="toc" class="toc2"><div id="book-search-input"><input id="search" type="text" placeholder="Type to search"></div><div id="toctitle"><span>API Reference</span></div><ul id="accordion" class="sectlevel1"><%for(api in apiDocList){%><%if(apiLP.first){%><li><a class="dd" href="${alias}.html#header">${api.order}. ${api.desc}</a><ul class="sectlevel2" style="display: none"><%for(doc in api.list){%><li><%if(doc.deprecated){%><a href="${alias}.html#_${api.order}_${doc.order}_${doc.desc}">${api.order}.${doc.order}. <span class="line-through">${doc.desc}</span></a><%}else{%><a href="${alias}.html#_${api.order}_${doc.order}_${doc.desc}">${api.order}.${doc.order}. ${doc.desc}</a><%}%></li><%}%></ul></li><%}else{%><li><a class="dd" href="${api.alias}.html#header">${api.order}. ${api.desc}</a><ul class="sectlevel2" style="display: none"><%for(doc in api.list){%><li><%if(doc.deprecated){%><a href="${api.alias}.html#_${api.order}_${doc.order}_${doc.desc}">${api.order}.${doc.order}. <span class="line-through">${doc.desc}</span></a><%}else{%><a href="${api.alias}.html#_${api.order}_${doc.order}_${doc.desc}">${api.order}.${doc.order}. ${doc.desc}</a><%}%></li><%}%></ul></li><%}%><%}%><%if(isNotEmpty(errorCodeList)){%><li class="open"><a href="error.html#header">${apiDocList.~size+1}.${errorListTitle}</a><ul class="sectlevel2" style="display: block"><li><a href="error.html#_${apiDocList.~size+1}_1_${errorListTitle}">${apiDocList.~size+1}.1. ${errorListTitle}</a></li></ul></li><%}%><%if(isNotEmpty(dictList)){%><li><a class="dd" href="dict.html#_dict_list">${dictListOrder}. ${dictListTitle}</a><ul class="sectlevel2"><%for(dict in dictList){%><li><a href="dict.html#_${dictListOrder}_${dict.order}_${dict.title}">${dictListOrder}.${dict.order}. ${dict.title}</a></li><%}%></ul></li><%}%></ul></div></div><div id="content"><%if(isNotEmpty(errorCodeList)){%><div class="sect1"><h2 id="_error_code_list"><a class="anchor" href="#_error_code_list"></a><a class="link" href="#_error_code_list">${apiDocList.~size+1}. ${errorListTitle}</a></h2><div class="sectionbody"><div class="sect2"><h3 id="_${apiDocList.~size+1}_1_${errorListTitle}"><a class="anchor" href="#_${apiDocList.~size+1}_1_${errorListTitle}"></a><a class="link" href="#_${apiDocList.~size+1}_1_${errorListTitle}">${apiDocList.~size+1}.1. ${errorListTitle}</a></h3><table class="tableblock frame-all grid-all spread"><colgroup><col style="width: 50%;"><col style="width: 50%;"></colgroup><thead><tr><th class="tableblock halign-left valign-top">Error code</th><th class="tableblock halign-left valign-top">Description</th></tr></thead><tbody><%for(error in errorCodeList){%><tr><td class="tableblock halign-left valign-top"><p class="tableblock">${error.value}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">${error.desc}</p></td></tr><%}%></tbody></table></div></div></div><%}%><footer class="page-footer"><span class="copyright">Generated by smart-doc at ${createTime}</span><span class="footer-modification">Suggestions,contact,support and error reporting on<a href="https://gitee.com/smart-doc-team/smart-doc" target="_blank"> Gitee</a> or<a href="https://github.com/smart-doc-group/smart-doc.git" target="_blank"> Github</a></span></footer></div>
|
||||
<!DOCTYPE html><html lang="en"><head><meta charset="UTF-8"><meta name="viewport"content="width=device-width, initial-scale=1.0"><meta name="generator"content="smart-doc"><title>SpringBoot2-Open-Api</title><link rel="stylesheet"href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"><link rel="stylesheet"href="AllInOne.css?v=1607962934038"/><link rel="stylesheet"href="https://cdn.bootcdn.net/ajax/libs/highlight.js/10.3.2/styles/xt256.min.css"><style>.literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#000}.hljs{padding:0em}</style><script src="https://cdn.bootcdn.net/ajax/libs/highlight.js/10.3.2/highlight.min.js"></script><script src="https://cdn.bootcss.com/jquery/2.2.4/jquery.min.js"></script></head><body class="book toc2 toc-left"><div id="header"><%if(isNotEmpty(projectName)){%><h1>${projectName}</h1><%}%><div id="toc"class="toc2"><div id="book-search-input"><input id="search"type="text"placeholder="Type to search"></div><div id="toctitle"><span>API Reference</span></div><ul id="accordion"class="sectlevel1"><%for(api in apiDocList){%><%if(apiLP.first){%><li><a class="dd"href="${alias}.html#header">${api.order}. ${api.desc}</a><ul class="sectlevel2"style="display: none"><%for(doc in api.list){%><li><%if(doc.deprecated){%><a href="${alias}.html#_${api.order}_${doc.order}_${doc.desc}">${api.order}.${doc.order}. <span class="line-through">${doc.desc}</span></a><%}else{%><a href="${alias}.html#_${api.order}_${doc.order}_${doc.desc}">${api.order}.${doc.order}. ${doc.desc}</a><%}%></li><%}%></ul></li><%}else{%><li><a class="dd"href="${api.alias}.html#header">${api.order}. ${api.desc}</a><ul class="sectlevel2"style="display: none"><%for(doc in api.list){%><li><%if(doc.deprecated){%><a href="${api.alias}.html#_${api.order}_${doc.order}_${doc.desc}">${api.order}.${doc.order}. <span class="line-through">${doc.desc}</span></a><%}else{%><a href="${api.alias}.html#_${api.order}_${doc.order}_${doc.desc}">${api.order}.${doc.order}. ${doc.desc}</a><%}%></li><%}%></ul></li><%}%><%}%><%if(isNotEmpty(errorCodeList)){%><li class="open"><a href="error.html#header">${apiDocList.~size+1}. ${errorListTitle}</a><ul class="sectlevel2"style="display: block"><li><a href="error.html#_${apiDocList.~size+1}_1_${errorListTitle}">${apiDocList.~size+1}.1. ${errorListTitle}</a></li></ul></li><%}%><%if(isNotEmpty(dictList)){%><li><a class="dd"href="dict.html#_dict_list">${dictListOrder}. ${dictListTitle}</a><ul class="sectlevel2"><%for(dict in dictList){%><li><a href="dict.html#_${dictListOrder}_${dict.order}_${dict.title}">${dictListOrder}.${dict.order}. ${dict.title}</a></li><%}%></ul></li><%}%></ul></div></div><div id="content"><%if(isNotEmpty(errorCodeList)){%><div class="sect1"><h2 id="_error_code_list"><a class="anchor"href="#_error_code_list"></a><a class="link"href="#_error_code_list">${apiDocList.~size+1}. ${errorListTitle}</a></h2><div class="sectionbody"><div class="sect2"><h3 id="_${apiDocList.~size+1}_1_${errorListTitle}"><a class="anchor"href="#_${apiDocList.~size+1}_1_${errorListTitle}"></a><a class="link"href="#_${apiDocList.~size+1}_1_${errorListTitle}">${apiDocList.~size+1}.1. ${errorListTitle}</a></h3><table class="tableblock frame-all grid-all spread"><colgroup><col style="width: 50%;"><col style="width: 50%;"></colgroup><thead><tr><th class="tableblock halign-left valign-top">Error code</th><th class="tableblock halign-left valign-top">Description</th></tr></thead><tbody><%for(error in errorCodeList){%><tr><td class="tableblock halign-left valign-top"><p class="tableblock">${error.value}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">${error.desc}</p></td></tr><%}%></tbody></table></div></div></div><%}%><footer class="page-footer"><span class="copyright">Generated by smart-doc at ${createTime}</span><span class="footer-modification">Suggestions,contact,support and error reporting on<a href="https://gitee.com/smart-doc-team/smart-doc"target="_blank"> Gitee</a> or<a href="https://github.com/smart-doc-group/smart-doc.git"target="_blank"> Github</a></span></footer></div>
|
||||
<script src="search.js?v=${version}"></script>
|
||||
<script>
|
||||
$(function () {
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
Loading…
Reference in New Issue