API文档与模拟数据接口
一. RESTful
1.1 什么是RESTful架构
是一个流行的互联网架构
REST 即Representational State Transfer,“表现层状态转化”。
1.每一个URL代表一种资源
2.客户端和服务器之间,传递这种资源的某种表现层
3.客户端通过四核HTTP(get post put delete)动词,对服务器端资源进行操作,实现“表现层状态转换”
二.Swagger
2.1 什么是Swagger
前后端唯一的联系,编程了API接口,Api文档编程了前后端开发人员联系的纽带,变得越来越重要,swagger就是一款让你更好的书写API文档的框架
2.2 Swagger Editor 安装与启动
1.到官网下载https://github.com/swagger-api/swagger-editor/releases
2.解压
3.用以下命令安装HTTP服务器
npm install http-server -g
4.在swagger目录的上一级用一下命令启动服务
http-server swagger-editor-3.14.5
5.输入启动后提示的网址即可登陆
三.mock.js
Mock.js (官网http://mockjs.com/)是一款模拟数据生成器,旨在帮助前端攻城师独立 于后端进行开发,帮助编写单元测试。提供了以下模拟功能: 根据数据模板生成模拟数据 模拟 Ajax 请求,生成并返回模拟数据 基于 HTML 模板生成模拟数据
3.1 安装
新建一个目录用来存放mock.js的目录
进入该目录的命令行:
npm install mockjs
3.2 测试
打开vscode,打开mock的文件夹,新建一个demo1。
list|5 : 代表list这个对象生成五次
(注:不同类型的value 对应的 | 后面的作用都是不同的,具体参考资料)
data后面的参数,第二个null是数据转换的函数,此处不需要,第三个4代表缩进4格
//生成一个列表数据,5条 包含id 和 name属性
let Mock = require('mockjs')
//模拟对象
let data = Mock.mock({
'list|5':[
{
id:1,
name:'测试'
}