Java项目 (SpringBoot+SpringCloud) 十次方:前端(二) API文档与模拟数据接口

1 RESTful

一.理解RESTful架构

1. 要理解RESTful架构，最好的方法就是去理解Representational State Transfer这个词组到底是什么意思，它的每一个词代表了什么涵义。
   
2. （1）每一个URI代表一种资源；
   （2）客户端和服务器之间，传递这种资源的某种表现层；
   （3）客户端通过四个HTTP动词，对服务器端资源进行操作，实现"表现层状态转化"。
3. 客户端用到的手段，只能是HTTP协议。具体来说，就是HTTP协议里面，四个表示操作方式的动词：GET、POST、PUT、DELETE。它们分别对应四种基本操作：GET用来获取资源，POST用来新建资源（也可以用于更新资源），PUT用来更新资源，DELETE用来删除资源。

二.常见错误

1. URI包含动词
   
   正确的写法是把动词transfer改成名词transaction
2. URI包含版本
   
   因为不同的版本，可以理解成同一种资源的不同表现形式，所以应该采用同一个URI。版本号可以在HTTP请求头信息的Accept字段中进行区分
   

2 运用Swagger编写API文档

一.Swagger

1. 什么是Swagger
   随着互联网技术的发展，现在的网站架构基本都由原来的后端渲染，变成了：前端渲染、前后端分离的形态，而且前端技术和后端技术在各自的道路上越走越远。
   前端和后端的唯一联系，变成了API接口；API文档变成了前后端开发人员联系的纽带，变得越来越重要， swagger 就是一款让你更好的书写API文档的框架。
2. SwaggerEditor安装与启动
   （1）下载 https://github.com/swagger-api/swaggereditor/releases/download/v2.10.4/swagger-editor.zip。
   （2）解压swagger-editor,
   （3）全局安装http-server(http-server是一个简单的零配置命令行http服务器)
   
   （4）启动swagger-editor
   
   （5）浏览器打开： http://localhost:8080

二.SwaggerUI

SwaggerUI是用来展示Swagger文档的界面，以下为安装步骤

1. 在本地安装nginx
2. 下载SwaggerUI源码 https://swagger.io/download-swagger-ui/
3. 解压，将dist文件夹下的全部文件拷贝至 nginx的html目录
4. 启动nginx
5. 浏览器打开页面 http://localhost即可看到文档页面
6. 我们将编写好的yml文件也拷贝至nginx的html目录，这样我们就可以加载我们的swagger文档了
   

3 Mock.js

一.什么是Mock.js

1. Mock.js （官网http://mockjs.com/）是一款模拟数据生成器，旨在帮助前端攻城师独立于后端进行开发，帮助编写单元测试。提供了以下模拟功能：
   根据数据模板生成模拟数据
   模拟 Ajax 请求，生成并返回模拟数据
   基于 HTML 模板生成模拟数据

二.Mock.js安装

1. 在命令提示符下用npm安装mockjs
   

4 EasyMock

一.什么是EasyMock

1. Easy Mock 是杭州大搜车无线团队出品的一个极其简单、高效、可视化、并且能快速生成模拟数据的 在线 mock 服务 。以项目管理的方式组织 Mock List，能帮助我们更好的管理 Mock 数据。
2. 地址：https://www.easy-mock.com
   在线文档：https://www.easy-mock.com/docs

二.本地部署EasyMock

1. Centos部署node.js
   1. 将node官网下载的node-v8.11.1-linux-x64.tar.xz 上传至服务器
   2. 解压xz文件
      
   3. 解压tar文件
      
   4. 目录重命名
      
   5. 移动目录到/usr/local下
      
   6. 配置环境变量
      
      填写以下内容
      
      执行命令让环境变量生效
      
      查看node版本看是否安装成功
      
2. MongoDB安装与启动
   我们使用yum方式安装mongoDb
   1. 配置yum
      
      编辑以下内容：
      
   2. 安装MongoDB
      
   3. 启动MongoDB
      
3. Redis安装与启动
   1. 下载fedora的epel仓库
      
   2. 下载安装redis
      
   3. 启动redis服务
      
4. 本地部署easy-mock
   1. 项目下载地址： https://github.com/easy-mock/easy-mock
   2. 将easy-mock-dev.zip上传至服务器
   3. 安装zip 和unzip
      
   4. 解压
      
   5. 进入其目录，安装依赖
      
   6. 执行构建
      
   7. 启动
      
   8. 打开浏览器 http://192.168.184.131:7300
      

三.导入SwaggerAPI文档

1. 将我们的SwaggerAPI文档扩展名改为yml
2. 在easyMock中点击“设置”选项卡
3. SwaggerDocs API 选择Upload
   
4. 将SwaggerAPI文档拖动到上图的虚线区域，点击保存
5. 回到主界面后点击“同步Swagger”