更新 javadoc tag使用/自定义tag使用.md

上官胡闹 2020-12-22 22:00:49 +08:00 committed by Gitee
parent d3e65d8176
commit 2718409580
1 changed files with 26 additions and 0 deletions

@ -10,6 +10,11 @@ tag名称 | 描述
@order|从smart-doc 1.9.4开始order tag用于设置controller接口或者api入口的自定义排序序号@order 1就表示设置序号为1。
@ignoreResponseBodyAdvice|从smart-doc 1.9.8开始ignoreResponseBodyAdvice tag用于忽略ResponseBodyAdvice设置的包装类。
@download|从smart-doc 2.0.1开始download tag用于标注在controller的文件下载方法上生成debug页面时可实现文件下载测试。并且支持下载文件带请求头参数测试。
@page|从smart-doc 2.0.2开始page tag用于标注在controller的文件下载方法上表示该方法用户渲染返回一个静态页面生成debug页面时如果发起测试测试页面会自动在浏览器开启新标签显示页面。
下面是各个tag的使用例子
## 1.1 @ignore tag使用
```java
@ -233,6 +238,27 @@ public class DownloadController extends BaseController {
```
> smart-doc 2.0.2版本将会自动从下载响应头`Content-Disposition: attachment; filename=xx`中读取文件名,不再需要在响应头中设置`response.setHeader("filename", urlEncode(fileName));`。当然即便是Content-Disposition也记得使用urlEncode处理下文档名否则出出现中文文件名乱码。
## 1.4 @page tag使用
```
/**
* arthas火焰图列表
*
* @return
* @page /arthas-output.html
* @apiNote 返回一个展示火焰图文件的arthas-output.html
*/
@GetMapping("arthas-output.html")
public String render() {
Template template = BeetlTemplateUtil.getByName("arthas-output.tpl");
List<FileInfo> files = FileUtil.getFilesFromFolder(environment.getProperty("arthas.output.path", OUTPUT_PATH));
template.binding("path", "arthas-output");
template.binding("fileInfoList", files);
return template.render();
}
```
> 这个例子中用beetl来编写了一个html模板正常情况下访问arthas-output.html。会返回渲染后的界面如果你想在debug页面中点击请求直接访问该页面那么你可以用@page来告诉smart-doc你的渲染页面名称。这样在debug页面上就可以直接帮你打开新的页签来访问页面。
# 二、IDEA自定义tag提示
自定义的tag默认是不会自动提示的需要用户在idea中进行设置。设置好后即可使用下面以设置smart-doc自定义的mock tag为例设置操作如下