SpringBoot(十八):SpringBoot2.1.1引入SwaggerUI工具

旧街凉风 提交于 2019-12-02 19:53:47

Swagger是一个有用web界面的提供实体模型结构展示,接口展示,调测等的一个工具,使用它可以提高开发者开发效率,特别是前后端配合开发时,大大省去了沟通接口耗费的时间:服务端开发完接口发布后,UI端直接就可以通过Swagger提供的文档信息就能很容易理解哪些接口需要传递哪些参数,以及参数是否必填,参数类型等。

上边只是提到了个人使用过程中,感受到的优势,就这些优势足够吸引开发者使用该工具,使用Swagger需要完整一下几步操作:

1)新建SpringBoot工程,并还引入swagger ui依赖包;

2)在SpringBoot中添加Swagger配置类,启用swagger,并设置配置项;

3)定义实体类,实体类加上文档注解;

4)定义Restful Api接口,并添加文档注释。

5)发布访问。

下边针对上边的步骤进行详细介绍:

1)新建SpringBoot工程,并还引入swagger ui依赖包;

 

2)在SpringBoot中添加Swagger配置类,启用swagger,并设置配置项;

 

3)定义实体类,实体类加上文档注解;

 

4)定义Restful Api接口,并添加文档注释。

 

5)发布访问。

 

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!