16-尚硅谷-微信支付-创建案例项目-引入Swagger

好，我们已经成功的开发了第一个接口，那接下来呢，为了后面接口测试的方便呢，我们来引入一个工具叫做swagger。我们先在我们的文件当中将SSPA相关的依赖呢引进来。那么swagger是这样的一个单词，它可以帮助我们自动的生成接口文档和相关的测试页面，这样的话，未来我们在测试一些嗯，Get方式或者是post方式，Delete方式和put方式的接口的时候呢，就更为方便了。那么首先呢，我们把这个依赖呢给它添加进来，那么这个依赖呢，一个是swagger two。我们选择2.7这个版本，然后上面这个位置呢，是io.spring FOX，好，然后我们2.7。2.7.0，好，然后接下来呢，除了这个的核心依赖之外呢，还有一个SPA的UI依赖。

那它可以帮助我们展示一个具体的HTML的页面，来展示我们的接口文档，还有这个，嗯，测试页面，那么这面呢，是我们的swa的。图形用户界面啊，也就是UI。好，那么引入依赖呢，是第一个步骤，我们不要忘了在面板当中刷新一下，把这两个依赖呢，真正的引入到我们的项目当中，接下来呢，我们为S创建一个配置文件。那么我们在payment DEMO这个包下面创建一个package，叫做config配包，我们未来所有的项目当中的配置呢，都会放在这个包下面，那么swaer的配置文件呢，是我们创建的第一个配置文件swagger To Big这个名字可以随意的起。好，那因为它是一个配置文件，所以呢，我们先写一个注解叫configuration，因为呢它是swa的配置，所以呢，我们必须添加一个叫做enable swa to的主件来代表它是一个swa的配置文件，接下来呢，我们配置一个并对象，那么这个并对象呢？

返回的值呢，就是一个当中的文档对象叫好。方法的名字也是一样，由我们来自己定义，然后接下来呢，我们需要的其实就是这个对象，那么这个具体的类型呢，是由它的构造函数当中的参数来定义的啊，叫documentation type，然后里面呢，我们选swa。那这个其实就是我们创建的一个对象，我们需要把它扭出来，然后返回就可以了，那么我们重新启动一下我们的项目看一看呢，经过这样的一系列的配置之后。我们的应用程序会发生什么变化？

好，应用程序呢，已经启动成功了，此时呢，我们来访问swa的。测试地址local host，那还是我们的8090端口，只不过呢，我们的页面呢，要访问SPA个默认给我们供的这样的一个地址叫i.HTL那这个呢，就是我们的的一个测试页面了，就是根据我们开发的接口自动生成的，刚才我们开发了一个叫做product controller的一个接口。而接口里面呢，有一个test方法，所以在这个位置呢，就展示出了接口的一个测试文档，相当于那么在这个地方呢，有一个try it out，我们点击一下，那么在下面response body这个位置呢，就展示了我们这个接口的返回，好，那么你会发现其实这个呢，就是我们接口的地址了啊。这是我们swagger文档。那我们还可以对这个文档呢，做进一步的配置，比如说我们可以给这个文档呢，定义一个标题，我们可以呢，给我们的具体的接口呢，添加一些说明。

那给文档进行配置呢，我们需要在这个配置文件当中啊，让这个dock呢的配置信息呢更丰富一些。我们可以在这个位置添加一个叫做API方法，那么这个API方里呢，接收一个叫做API，这个怎么建呢？我们通过。一个叫做API。For。这么一个工具类哈，来创建我们的这个API，那当然了，我们需要把这个工具类呢，给它实例化出来，所以用一个new，然后接下来呢，就有各种各样的方法了，比如说我们可以定义文档的标题，定义文档的描述，那这里面呢，我们就定义一个文档的标题，比如说这是。

微信支付案例接口文档。好，然后最后呢，不要忘记再写一个叫做build的方法，那么这个build的方法呢，最后呢，会返回一个API info这样的一个对象，正好呢是我们API info这个方法需要的，那我们就配置好了瓦的。一个基本的信息。好，我们来刷新一下这个页面。那这面呢，就显示出了文档的标题，那接下来呢，我们在添加两个非常有用的注解，一个呢是ctrler里面我们添加一个API，好API这个里面呢，我们添加一个叫做text的一个属性，那上面呢我们写商品。

管理好，然后接下来呢方法，方法上呢，我们添加一个叫API operation的注解。然后它的默认值呢是value，那所以这个value我们就省略它好，然后这面呢，我们添加一个名字，比如说就叫做测试接口吧。好，那接下来呢，我们来重新启动一下我们的后端服务。好，重启完毕之后呢，我们来刷新一下我们这个页面，那么你会发现刚才我们定义的这两个注解，一个呢就体现在了这个位置，另外一个呢，就体现在了这个位置，这样的话呢，就方便我们在后期做测试的时候，在这个里面找到相应的接口，然后进行测试。