1 RESTful
一.理解RESTful架构
- 要理解RESTful架构,最好的方法就是去理解Representational State Transfer这个词组到底是什么意思,它的每一个词代表了什么涵义。
- (1)每一个URI代表一种资源;
(2)客户端和服务器之间,传递这种资源的某种表现层;
(3)客户端通过四个HTTP动词,对服务器端资源进行操作,实现"表现层状态转化"。 - 客户端用到的手段,只能是HTTP协议。具体来说,就是HTTP协议里面,四个表示操作方式的动词:GET、POST、PUT、DELETE。它们分别对应四种基本操作:GET用来获取资源,POST用来新建资源(也可以用于更新资源),PUT用来更新资源,DELETE用来删除资源。
二.常见错误
- URI包含动词
正确的写法是把动词transfer改成名词transaction - URI包含版本
因为不同的版本,可以理解成同一种资源的不同表现形式,所以应该采用同一个URI。版本号可以在HTTP请求头信息的Accept字段中进行区分
2 运用Swagger编写API文档
一.Swagger
- 什么是Swagger
随着互联网技术的发展,现在的网站架构基本都由原来的后端渲染,变成了:前端渲染、前后端分离的形态,而且前端技术和后端技术在各自的道路上越走越远。
前端和后端的唯一联系,变成了API接口;API文档变成了前后端开发人员联系的纽带,变得越来越重要, swagger 就是一款让你更好的书写API文档的框架。 - 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文档的界面,以下为安装步骤
- 在本地安装nginx
- 下载SwaggerUI源码 https://swagger.io/download-swagger-ui/
- 解压,将dist文件夹下的全部文件拷贝至 nginx的html目录
- 启动nginx
- 浏览器打开页面 http://localhost即可看到文档页面
- 我们将编写好的yml文件也拷贝至nginx的html目录,这样我们就可以加载我们的swagger文档了
3 Mock.js
一.什么是Mock.js
- Mock.js (官网http://mockjs.com/)是一款模拟数据生成器,旨在帮助前端攻城师独立于后端进行开发,帮助编写单元测试。提供了以下模拟功能:
根据数据模板生成模拟数据
模拟 Ajax 请求,生成并返回模拟数据
基于 HTML 模板生成模拟数据
二.Mock.js安装
- 在命令提示符下用npm安装mockjs
4 EasyMock
一.什么是EasyMock
- Easy Mock 是杭州大搜车无线团队出品的一个极其简单、高效、可视化、并且能快速生成模拟数据的 在线 mock 服务 。以项目管理的方式组织 Mock List,能帮助我们更好的管理 Mock 数据。
- 地址:https://www.easy-mock.com
在线文档:https://www.easy-mock.com/docs
二.本地部署EasyMock
- Centos部署node.js
- 将node官网下载的node-v8.11.1-linux-x64.tar.xz 上传至服务器
- 解压xz文件
- 解压tar文件
- 目录重命名
- 移动目录到/usr/local下
- 配置环境变量
填写以下内容
执行命令让环境变量生效
查看node版本看是否安装成功
- MongoDB安装与启动
我们使用yum方式安装mongoDb- 配置yum
编辑以下内容: - 安装MongoDB
- 启动MongoDB
- 配置yum
- Redis安装与启动
- 下载fedora的epel仓库
- 下载安装redis
- 启动redis服务
- 下载fedora的epel仓库
- 本地部署easy-mock
- 项目下载地址: https://github.com/easy-mock/easy-mock
- 将easy-mock-dev.zip上传至服务器
- 安装zip 和unzip
- 解压
- 进入其目录,安装依赖
- 执行构建
- 启动
- 打开浏览器 http://192.168.184.131:7300
三.导入SwaggerAPI文档
- 将我们的SwaggerAPI文档扩展名改为yml
- 在easyMock中点击“设置”选项卡
- SwaggerDocs API 选择Upload
- 将SwaggerAPI文档拖动到上图的虚线区域,点击保存
- 回到主界面后点击“同步Swagger”