我正在使用springrestdocs来生成api文档,我希望所有参数、路径和响应字段json路径都被打印为表中的代码部分(asciidoc中的backticks)。
例如,json路径链轮。[].widgets.[].contenttype在可变宽度字体中比其他字体更难读取 sprockets.[].widgets.[].contentType
,用单格印刷。
请求参数和路径参数也是如此——它们是应该在monospace中打印的令牌。
用springrestdocs实现这一点最简单的方法是什么?
提前谢谢你的帮助。
克
2条答案
按热度按时间zmeyuzjn1#
您还可以使用asciidoctor格式化代码,例如“m”表示单空格:
您甚至可以更改列宽和对齐方式,例如三列相对宽度为4-4-2,第三列居中对齐:
(我知道这不是你所要求的,但是对于新加入asciidoc的anyo spring restdocs用户来说,知道有很多简单的定制选项可能会有所帮助)
看到了吗http://asciidoctor.org/docs/user-manual/#cols-格式
2ledvvac2#
我认为rest文档应该默认这样做。我打开了一个将在1.1中修复的问题:https://github.com/spring-projects/spring-restdocs/issues/230. 谢谢你的建议。
同时,您可以通过使用自定义代码段模板来做您想做的事情。例如,要自定义请求字段路径的格式,需要提供
request-fields.snippet
文件输入src/test/resources/org/springframework/restdocs/templates
看起来是这样的:注意周围的倒勾
{{path}}
.