简体   繁体   English

Springfox Swagger UI中的网址自定义评论(api-doc)

[英]Custom commentary for urls in Springfox Swagger UI (api-doc)

I have a spring boot aplication with springfox-swagger2 and springfox-swagger-ui (version 2.9.2) genereting nice interactive api documentation based on my @Controller components and their @RequestMapping annotated methods. 我有一个带有springfox-swagger2和springfox-swagger-ui(版本2.9.2)的spring boot aplication,它基于我的@Controller组件及其@RequestMapping注释的方法,提供了很好的交互式api文档。

I would llike to enhance generated documentation by custom commentary (eg via javadoc). 我想通过自定义评论(例如通过javadoc)增强生成的文档。 Is there a way to achieve this? 有没有办法实现这个目标? I have read through several tutorials and i am none the viser... 我已经阅读了几个教程,我不是视觉...

I finally discovered the solution. 我终于找到了解决方案。 The @Api annotation for controllers and @ApiOperation for mothods have attributes that are displayed in swagger UI. 控制器的@Api注释和@ApiOperation具有以swagger UI显示的属性。

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM