# 推送 Markdown 文档
Torna版本:1.33.1
接口描述默认支持html标签,如:
/**
* 新增产品
* @apiNote 这是一个html文本<br>
* <ul>
* <li>yyy</li>
* <li>xxx</li>
* </ul>
* 前端调用伪代码:
* <pre>
* axios.post('shop/product', data);
* </pre>
* @param param
* @return
*/
@PostMapping
public Result<String> add(@RequestBody ProductParam param) {
return Result.ok("11");
}
从1.33.1开始,支持编写Markdown文档,
格式:
@apiNote |md|Markdown文本
其中|md|
是标识符,表示后面的文本是Markdown格式。
完整代码如下:
/**
* 新增产品
* @apiNote |md|这是一个Markdown文本
* - xxx
* - yyy
* - xxx
* 前端调用伪代码:
* ```
* axios.post('shop/product', data);
* ```
* @param param
* @return
*/
@PostMapping
public Result<String> add(@RequestBody ProductParam param) {
return Result.ok("11");
}
对应关系如下图所示:
通过smart-doc推送后,前往Torna预览页面,即可看到Markdown文档。