swagger提供了html页面方便查看restful的api接口,以及测试功能,这样方便后期版本更新时的文档与代码的同步。

下面介绍整合步骤:

1.在spring项目中添加依赖


  springcloud整合swagger 界面查看restful apispringcloud整合swagger 界面查看restful api

2.创建类名为Swagger2的类,代码如下:


springcloud整合swagger 界面查看restful api

springcloud整合swagger 界面查看restful api

3.在我们编写的rest api处添加相应的注解,例如下图所示:


springcloud整合swagger 界面查看restful api

springcloud整合swagger 界面查看restful api

4.查看效果:

                访问地址: http://localhost:端口/swagger-ui.html


springcloud整合swagger 界面查看restful api

springcloud整合swagger 界面查看restful api

这样就完成了,个人感觉比去维护word文档要好一些。

相关文章: