初入Swagger接口框架

       在平时的学习与开发过程中,特别是RESTful大流行的背景下都会有前后端的联合调试,如果后端API接口全都写好了之后再与前端页面进行调试的话,效果会更好,但是实际开发之中,前后端是并行开发的,为了提高效率,一般都会用一些测试工具来测试服务端功能是否实现,比如postman、jmeter、loadrunner等,下面介绍一种用起来比以上工具更方便的工具Swagger。Swagger是一种通用的、和编程语言无关的API的描述规范,通过swagger,后端开发人员可以很好的对自己写的API接口进行测试,前端开发人员更方便地了解接口的类型,以及接口的url,并且清楚后端需要的参数值等等,这将大大提高项目的开发效率。

基于SpringBoot使用Swagger

1.在pom.xml文件添加依赖

初入Swagger接口框架_第1张图片

    第一个依赖引入swagger的api,第二个依赖是对swagger访问界面进行ui美化。

2.添加Swagger配置类

    一般为了规范,在项目路径下建一个放置配置类文件的config包,然后在此包下面写Swagger配置文件,内容如下

初入Swagger接口框架_第2张图片

3、controller控制层使用

初入Swagger接口框架_第3张图片

4、Swagger ui界面访问,便于测试接口功能

初入Swagger接口框架_第4张图片

 

你可能感兴趣的:(Java,swagger,java,spring,boot)