npm是Node.js的包管理器，JavaScript程序开发所需的第三方库都可以通过npm与世界各地的开发者和互联网使用者共享。agreed-core是一个基于 JSON Schema 的声明式API Mock和Stub生成器的npm包，可以很好地帮助我们实现前端开发中API开发和测试的自动化。本文就详细介绍了如何使用agreed-core来提高我们的前端开发效率。
安装
agreed-core作为一个npm包，我们可以通过npm命令来安装它：
npm install agreed-core --save-dev
使用方法
基本用法
我们在项目中新建一个agreed.js文件，然后在其中引入agreed-core：
const Agreed = require('agreed-core')接着，我们在该文件中定义一个简单的API：
-- -------------------- ---- -------
----- --- - -
-------- -
----- -------------
------- ------
------ -
----- -
----- ---------
--------- -----
------------ ------
-
-
--
--------- -
------- ----
----- -
-------- -
----- ---------
------ ------- --------
-
-
-
-我们定义了一个HTTP GET请求，路径为/api/hello，需要包含查询参数name，返回结果为message字段，其为一个字符串。现在我们就可以利用agreed-core来生成mock数据了：
const agreed = new Agreed() const mockResponse = agreed.mock(api) console.log(mockResponse)
执行完上述代码后，我们会看到生成的mock数据：
{ "message": "Hello, World!" }可以看到，我们定义的{name}变量已被正确解析，并生成了mock数据。
高级用法
agreed-core还支持很多高级用法，下面我们介绍两个常用的高级用法。
1. 输出JSON Schema
我们可以通过设置options参数来输出API的JSON Schema：
const agreed = new Agreed()
const jsonSchema = agreed.compile(api, { as: 'jsonSchema' })
console.log(jsonSchema)执行完上述代码后，我们会看到输出的JSON Schema：
-- -------------------- ---- -------
-
---------- ------------------------------------------
------- ---------
------------- -
---------- -
------- --------
-
--
----------- -
---------
-
-可以看到，我们生成了API的JSON Schema，这对于API的开发和测试非常有用。
2. 启用Middleware
我们可以将agreed-core作为Express或Koa的中间件使用，这样我们就可以在API请求处理的同时添加Mock数据，从而方便API测试：
const agreed = new Agreed()
const middleware = agreed.createMiddleware()
app.use('/api', middleware)这样，我们就将agreed-core作为Express的中间件使用，并设置路径为/api。当我们发送请求到该路径时，就会添加Mock数据。
指导意义
使用agreed-core可以大大提高前端API开发和测试的效率，同时也可以帮助我们减少人为错误的发生。在实际项目中，我们可以使用agreed-core来生成Mock数据，实现API测试的自动化，从而节省手动测试所需的时间和精力。同时，我们也可以利用agreed-core生成API的JSON Schema，方便我们理解和使用API。
示例代码
完整示例代码如下：
-- -------------------- ---- -------
----- ------ - ----------------------
----- --- - -
-------- -
----- -------------
------- ------
------ -
----- -
----- ---------
--------- -----
------------ ------
-
-
--
--------- -
------- ----
----- -
-------- -
----- ---------
------ ------- --------
-
-
-
-
----- ------ - --- --------
----- ------------ - ----------------
-------------------------
----- ---------- - ------------------- - --- ------------ --
-----------------------我们可以使用node命令来执行该示例代码，并查看输出结果。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5f349d79dbf7be33b2566e4d