在 Swagger 我绝对是新的,我有以下疑问:
我知道通常我必须在代码我的REST API之前创建Swagger文档并使用此文档来创建我的API(我知道从Swagger编辑器我也可以自动生成我的API服务器) .
我的问题是以下一个:
我正在开发一个实现我的REST API的Java应用程序(Spring Boot应用程序) . 我想使用Swagger来创建我的API文档 .
有办法自动完成吗?从我的Java代码到Swagger yaml 文件?例如,以某种方式为某些工具解析我的Java代码注释?
2 回答
是的,有一个工具可以很容易地从你已编写的代码生成swagger文档 .
这包含在Spring Appllication中将创建文档https://springfox.github.io/springfox/docs/current/
在我看来,这是正确的方法 . 不要创建文档并生成代码,而是生成文档 . 这就是Javadoc的创建方式 .
您不需要特别注释任何内容 .
使用Swagger创建一个类似于以下类的类来访问API:
然后使用以下内容访问API文档: