API接口开发
<h3><strong>描述</strong></h3>
<ul>
<li>该系统可以开发API接口提供服务。该系统使用Swagger2构建强大的RESTful API文档。</li>
<li>Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。
<h3><strong>POM文件配置</strong></h3></li>
<li>需要在pom文件中添加Swagger2相关的jar包
<img src="https://images.gitee.com/uploads/images/2018/1020/161143_b84e8a16_928853.png" alt="输入图片说明" title="屏幕截图.png" />
<h3><strong>创建Swagger2配置类</strong></h3></li>
<li>在com.yiran.framework.config包下面添加SwaggerConfig.java配置类。
<img src="https://images.gitee.com/uploads/images/2018/1020/162015_06dbff68_928853.png" alt="输入图片说明" title="屏幕截图.png" />
<h3><strong>app包说明</strong></h3>
<p><img src="https://images.gitee.com/uploads/images/2018/1020/163713_0a3089f2_928853.png" alt="输入图片说明" title="屏幕截图.png" /></p>
<h3><strong>Swagger注解说明</strong></h3>
<p><img src="https://images.gitee.com/uploads/images/2018/1020/163946_705d8685_928853.png" alt="输入图片说明" title="屏幕截图.png" />
<img src="https://images.gitee.com/uploads/images/2018/1020/164053_792032ad_928853.png" alt="输入图片说明" title="屏幕截图.png" /></p>
<h3><strong>API接口开发步骤</strong></h3></li>
<li>在com.yiran.project.app.controller包下面新建一个AppTestController(根据实际情况)，在类上加@RestController返回json数据，@RequestMapping("/api/yiran")请求url，@Api(value="APP接口测试",tags={"APP接口测试"})
<img src="https://images.gitee.com/uploads/images/2018/1020/171256_15b7c6cc_928853.png" alt="输入图片说明" title="屏幕截图.png" /></li>
<li>启动项目，登录系统点击菜单【系统工具】-【API接口】，展示的RESTful API的页面。
<img src="https://images.gitee.com/uploads/images/2018/1023/094317_ae39e8ab_928853.png" alt="输入图片说明" title="屏幕截图.png" /></li>
<li>点开具体的API请求，以GET类型的GET /api/yiran/userId请求为例，可找到上述代码中我们配置的Notes信息以及参数userID的描述信息，如下图所示。
<img src="https://images.gitee.com/uploads/images/2018/1020/173312_b6a66ea9_928853.png" alt="输入图片说明" title="屏幕截图.png" /></li>
<li>Swagger除了查看接口功能外，还提供了调试测试功能，我们可以输入参数，点击下方“Try it out！”按钮，即可完成了一次请求调用！</li>
</ul>