API文档与模拟数据接口

一. RESTful
- 1.1 什么是RESTful架构
二.Swagger
- 2.1 什么是Swagger
- 2.2 Swagger Editor 安装与启动
三.mock.js
- 3.1 安装
- 3.2 测试
- 3.3 数据占位符定义规范DPD
- - 3.3.1 基本方法
  - 3.3.2 图像方法
  - 3.3.3 文本方法
  - 3.3.4 名称方法
  - 3.3.5 网络方法
四.EasyMock
- 4.1 什么是EasyMock
- 4.2 本地部署EasyMock
- - 4.2.1 Centos部署node.js
  - 4.2.2 MongoDB安装与启动
  - 4.2.3 安装Redis
  - 4.2.4 部署Easy-mock
  - 4.2.5 导入SwaggerAPI文档

一. 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:'测试'}]
})
console.log(JSON.stringify(data,null,4));

3.3 数据占位符定义规范DPD

Mock.Random 是一个工具类，用于生成各种随机数据。
Mock.Random 的方法在数据模板中称为『占位符』，书写格式为 @占位符(参数 [, 参数]) 。
内置方法列表：

3.3.1 基本方法

可以生成随机的基本数据类型
string 字符串
integer 整数
date 日期

// 使用 Mocklet Mock = require('mockjs') let data = Mock.mock({ 'list|10': [{'id|+1': 1,'name':'@string','point':'@integer', 'birthday':'@date' }]
})// 输出结果 console.log(JSON.stringify(data,null,2))

3.3.2 图像方法

image 随机生成图片地址

'pic':'@image'

3.3.3 文本方法

@title: 标题（会产生英文）
@cword(100) :文本内容参数为字数（会产生中文，（100）：100个汉字）

'title':'@title',
'content':'@cword(100)'

3.3.4 名称方法

cname :中文名称
cfirst:中文姓氏
Last:英文姓氏

'name':'@cname',
'ename':'@last',
'cfirst':'@cfirst',

3.3.5 网络方法

可以生成url ip email等网络相关信息

'url':"@url",
'ip':"@ip",
'email':"@email"

四.EasyMock

4.1 什么是EasyMock

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

4.2 本地部署EasyMock

4.2.1 Centos部署node.js

1.将官网下载的node-linux-X64 上传至服务器
2.解压xz

 xz -d node-v14.15.0-linux-x64.tar.xz

3.解压tar

tar -xvf node-v14.15.0-linux-x64.tar

4.改名

mv node-v14.15.0-linux-x64 node

5.移动到/usr/local下

mv node /usr/local/

6.配置环境变量

vi /etc/profile

#set for nodejs
export NODE_HOME=/usr/local/node
export PATH=$NODE_HOME/bin:$PATH

7.执行命令让环境变量生效

source /etc/profile

8.检测安装是否成功

node -v

4.2.2 MongoDB安装与启动

使用yum源安装
1.配置yum

vi /etc/yum.repos.d/mongodb‐org‐3.2.repo

[mongodb-org-3.2]
name=MongoDB Repository
baseurl=https://repo.mongodb.org/yum/redhat/$releasever/mongodb-org/3.2/x86_64/
gpgcheck=1
enabled=1
gpgkey=https://www.mongodb.org/static/pgp/server-3.2.asc

yum clean all
yum makecache

2.下载启动

yum install -y mongodb-org

systemctl start mongod

4.2.3 安装Redis

1.下载fedora的epel仓库

yum install epel-release

2.下载redis

yum install redis

3.启动redis

systemctl start redis

4.2.4 部署Easy-mock

1.项目下载地址： https://github.com/easy-mock/easy-mock
2.将easy-mock-dev.zip上传至服务器
3.安装zip 和unzip

yum install zip unzip

4.解压

unzip easy‐mock‐dev.zip

5.进入其目录，安装依赖

npm install

6.执行构建
如过构建失败可以尝试删除node_modules/和 package-lock.json，重新npm install安装依赖

 npm run build

7.启动
访问不了，请先关闭防火墙
启动后默认是ip：7300访问

 npm run start

4.2.5 导入SwaggerAPI文档

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

微服务社交平台项目【十次方】（二）-API文档与模拟数据接口相关推荐

JAVA计算机毕业设计携手同游旅游社交平台Mybatis+源码+数据库+lw文档+系统+调试部署
JAVA计算机毕业设计携手同游旅游社交平台Mybatis+源码+数据库+lw文档+系统+调试部署 JAVA计算机毕业设计携手同游旅游社交平台Mybatis+源码+数据库+lw文档+系统+调试部署本源 ...
JAVA计算机毕业设计郑工社团交流服务信息平台Mybatis+源码+数据库+lw文档+系统+调试部署
JAVA计算机毕业设计郑工社团交流服务信息平台Mybatis+源码+数据库+lw文档+系统+调试部署 JAVA计算机毕业设计郑工社团交流服务信息平台Mybatis+源码+数据库+lw文档+系统+调试部 ...
基于Java毕业设计携手同游旅游社交平台源码+系统+mysql+lw文档+部署软件
基于Java毕业设计携手同游旅游社交平台源码+系统+mysql+lw文档+部署软件基于Java毕业设计携手同游旅游社交平台源码+系统+mysql+lw文档+部署软件本源码技术栈: 项目架构:B/S ...
java计算机毕业设计携手同游旅游社交平台源码+mysql数据库+lw文档+系统+调试部署
java计算机毕业设计携手同游旅游社交平台源码+mysql数据库+lw文档+系统+调试部署 java计算机毕业设计携手同游旅游社交平台源码+mysql数据库+lw文档+系统+调试部署本源码技术栈: ...
计算机毕业设计net中医康养会员服务信息管理平台（系统+数据库+源码+文档）
计算机毕业设计net中医康养会员服务信息管理平台(系统+数据库+源码+文档) net中医康养会员服务信息管理平台计算机毕业设计最新计算机专业原创开发毕业设计参考选题都有源码+数据库是近期作品 [1] ...
java计算机毕业设计公务用车管理智慧云服务监管平台源码+数据库+系统+lw文档+mybatis+运行部署
java计算机毕业设计公务用车管理智慧云服务监管平台源码+数据库+系统+lw文档+mybatis+运行部署 java计算机毕业设计公务用车管理智慧云服务监管平台源码+数据库+系统+lw文档+mybat ...
基于Java毕业设计郑工社团交流服务信息平台源码+系统+mysql+lw文档+部署软件
基于Java毕业设计郑工社团交流服务信息平台源码+系统+mysql+lw文档+部署软件基于Java毕业设计郑工社团交流服务信息平台源码+系统+mysql+lw文档+部署软件本源码技术栈: 项目架构 ...
Splinter入门（十四）API文档
Splinter入门(十四)API文档 1. Browser 2. DriverAPI 3. ElementAPI 4. CookieManager 5. ElementList 6. Request ...
springcloud微服务整合/集成swagger(knife4j-小刀)实现在线文档调试和查看功能
1.在gateway网关层加入以下依赖 <dependency><groupId>com.github.xiaoymin</groupId><artifact ...
opencv项目实战（二）——文档扫描OCR识别
一.项目描述二.代码详解 2.1 预定义参数 2.2 辅助函数 2.3 文档矫正 2.4 文档识别三.项目完整代码一.项目描述目的将图片中的文档矫正,并识别文档内容输入与输出方法流程核 ...

微服务社交平台项目【十次方】（二）-API文档与模拟数据接口