Spring Boot 2.x基础教程:使用Swagger2构建强大的API文档 (2)

完成上述代码添加后,启动Spring Boot程序,访问::8080/swagger-ui.html,就能看到下面这样带中文说明的文档了(其中标出了各个注解与文档元素的对应关系以供参考):

Spring Boot 2.x基础教程:使用Swagger2构建强大的API文档

Spring Boot 2.x基础教程:使用Swagger2构建强大的API文档

API文档访问与调试

在上图请求的页面中,我们看到user的Value是个输入框?是的,Swagger除了查看接口功能外,还提供了调试测试功能,我们可以点击上图中右侧的Model Schema(黄色区域:它指明了User的数据结构),此时Value中就有了user对象的模板,我们只需要稍适修改,点击下方“Try it out!”按钮,即可完成了一次请求调用!

此时,你也可以通过几个GET请求来验证之前的POST请求是否正确。

相比为这些接口编写文档的工作,我们增加的配置内容是非常少而且精简的,对于原有代码的侵入也在忍受范围之内。因此,在构建RESTful API的同时,加入Swagger来对API文档进行管理,是个不错的选择。

代码示例

本文的完整工程可以查看下面仓库中的chapter2-2目录:

Github:https://github.com/dyc87112/SpringBoot-Learning/tree/2.x

Gitee:https://gitee.com/didispace/SpringBoot-Learning/tree/2.x

如果您觉得本文不错,欢迎Star支持,您的关注是我坚持的动力!

欢迎关注我的公众号:程序猿DD,获得独家整理的学习资源和日常干货推送。如果您对我的专题内容感兴趣,也可以关注我的博客:didispace.com

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:https://www.heiqu.com/zzyppj.html