我已经制作了一个Spring Boot Web服务,我正在添加文档。我正在使用springfox-swagger2库来添加文档。例如,我有:
@RestController
@Api(description = "A long description of my API that needs to span multiple lines", tags = "My Endpoint")
public class MyEndpoint {
// rest of code
}
端点的描述相当长。有一个用户需要遵循的排序和一些我想在文档中向用户指出的关键参数。是否可以在@Api注释中为描述添加更好的格式?
现在,它内联标签和输出如下:
“我的终点:长篇描述......”
理想情况下,我可以为其添加一些HTML或CSS格式。
谢谢!
每条评论的编辑:
我使用的是springfox-swagger2版本2.7.0。
当我尝试在我的Api.description中加入markdown时:
@Api(description = "#Heading \n Some description")
我在swagger.json中得到以下内容:
{
"name": "My Endpoint",
"description": "#Heading \n Some description"
}