moon-easy-api:自动化生成基于MongoDB的接口

本文涉及的产品
云数据库 MongoDB,独享型 2核8GB
推荐场景:
构建全方位客户视图
简介: moon-easy-api:自动化生成基于MongoDB的接口

目录


前言

效果

试试

测试

缺陷

补充

前言


我是一个比较喜欢前端的爱好者,我其实很多时候都有做一些个人小项目demo的计划。


但是总是遇到一个问题。


我不想写接口!!


虽然也许只是很简单的一些增删改查也让我觉得很麻烦。


我学过java,但是让我为了做一个小demo用java整一套ssm的后端服务想想就麻烦。


我又想到我还用过MongoDB,我的本地机和租借的云服务器都部署好了MongoDB,结合nodejs,不考虑企业级的规范,用express只要写app.js一个文件直接执行起来,就能有可以用的接口了。


只是写起来还是很麻烦,我也不需要特别复杂的调用,只要能支持我的小项目使用的增删改查就够,都是一些重复的东西,于是我萌生一个想法,重复的内容封装起来,用文件配置的形式,只要添加一个文件,运行起来接口就给我部署好了,于是我开始尝试…


效果


express的基础服务器框架,你只需要创建一个app的实例,连接自己的mongodb数据库,然后导入我上传的npm包,将app实例和数据库mongoose传入方法即可。

image.png

在你的服务端根目录创建一个apiModel文件夹(必须是该名称),然后可以添加你要的数据对象,就是用于生成数据库表信息的一个对象,按类似形式导出。

image.png

运行app.js。

image.png

试试


新建一个项目,test

生成package.json

npm init -y

运行结果

C:\Users\chenshaojun\Desktop\test>npm init -y
Wrote to C:\Users\chenshaojun\Desktop\test\package.json:
{
  "name": "test",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC"
}

我们可能需要添加对es6模块的支持。

image.png

然后在根目录npm下载我的npm包,名字叫做moon-easy-api

npm i moon-easy-api -S

运行结果

C:\Users\chenshaojun\Desktop\test>npm i moon-easy-api -S
npm WARN deprecated urix@0.1.0: Please see https://github.com/lydell/urix#deprecated
npm WARN deprecated resolve-url@0.2.1: https://github.com/lydell/resolve-url#deprecated
npm WARN deprecated querystring@0.2.1: The querystring API is considered Legacy. new code should use the URLSearchParams API instead.
added 403 packages, and audited 404 packages in 33s
16 packages are looking for funding
  run `npm fund` for details
found 0 vulnerabilities

完成后编写我们的app.js。

image.png

import express from "express";
import mongoose from "mongoose";
import bodyParser from "body-parser";
import easyApi from 'moon-easy-api';
const app = express();
app.use(bodyParser.json());
//连接你的mongodb数据库注意数据库名我的是mydata
//你的自己创建好
mongoose.connect("mongodb://81.68.155.48:27017/mydata");
easyApi(app, mongoose);
app.listen(3000, function () {
  console.log("服务器开启中....端口号是:" + 3000);
});

再编写自己想要的model。

image.png

const model = {
  id: String,
  name: String,
  old: Number,
  sex: String,
};
export { model };

然后就可以运行app.js。

image.png

显示数据库连接成功就是完成对接口的创建了。


测试



成功后会再对应的端口生成可以增删改查的接口,根据我这里的model名字是other,other便会生成addother、deleteother、updateother、getother四个接口。


image.png

代码,注意args[0]是你要执行的接口名,在执行命令时传递

import fetch from "node-fetch";
const args = process.argv.slice(2)
const test = async () => {
  const response = await fetch("http://localhost:3000/" + args[0], {
    method: "POST",
    headers: {
      Accept: "application/json",
      "Content-Type": "application/json;charset=UTF-8",
    },
    body: JSON.stringify({
      id: "1",
      name: "月",
      old: 18,
      sex: "男",
    }),
  });
  const res = await response.json();
  console.log(res);
};
test();

需要的fetch包下载一下

npm i node-fetch -D

添加test命令

image.png

试试增查删

npm run test addother
npm run test getother
npm run test deleteother
C:\Users\chenshaojun\Desktop\test>npm run test addother
> test@1.0.0 test
> node test.js "addother"
(node:11188) ExperimentalWarning: stream/web is an experimental feature. This feature could change at any time
(Use `node --trace-warnings ...` to show where the warning was created)
{
  data: {
    _id: '61371d7081c5ef1c1aa87c1a',
    id: '1',
    name: '月',
    old: 18,
    sex: '男',
    __v: 0
  },
  msg: '添加成功'
}
C:\Users\chenshaojun\Desktop\test>npm run test getother
> test@1.0.0 test
> node test.js "getother"
(node:1320) ExperimentalWarning: stream/web is an experimental feature. This feature could change at any time
(Use `node --trace-warnings ...` to show where the warning was created)
{
  data: {
    _id: '61371d7081c5ef1c1aa87c1a',
    id: '1',
    name: '月',
    old: 18,
    sex: '男',
    __v: 0
  },
  code: 1,
  msg: '查询成功'
}
C:\Users\chenshaojun\Desktop\test>npm run test deleteother
> test@1.0.0 test
> node test.js "deleteother"
(node:8788) ExperimentalWarning: stream/web is an experimental feature. This feature could change at any time
(Use `node --trace-warnings ...` to show where the warning was created)
{ code: 2, msg: '删除成功' }

缺陷



1.目前所有对象必须传递id,因为内容是根据id进行查询的

2.目前没有考虑复杂的情况,关联表之类的都没有,只用于不同对象的增删改查。


补充



我感觉自己这个想法非常有用啊。


不只是用来生成简易接口做demo,工作的时候等不到后台数据我也可以自己创建简易接口自测。


不过目前还只是做了个开头,我想对自己这个想法进行更新迭代,比如可拓展的自定义接口,还是解决一下我这个必须传id的问题。


有没有有同样想法的前端开发者,可以私聊我交流交流,或者有没有厉害的前辈们想要指点一下。


相关实践学习
MongoDB数据库入门
MongoDB数据库入门实验。
快速掌握 MongoDB 数据库
本课程主要讲解MongoDB数据库的基本知识,包括MongoDB数据库的安装、配置、服务的启动、数据的CRUD操作函数使用、MongoDB索引的使用(唯一索引、地理索引、过期索引、全文索引等)、MapReduce操作实现、用户管理、Java对MongoDB的操作支持(基于2.x驱动与3.x驱动的完全讲解)。 通过学习此课程,读者将具备MongoDB数据库的开发能力,并且能够使用MongoDB进行项目开发。   相关的阿里云产品:云数据库 MongoDB版 云数据库MongoDB版支持ReplicaSet和Sharding两种部署架构,具备安全审计,时间点备份等多项企业能力。在互联网、物联网、游戏、金融等领域被广泛采用。 云数据库MongoDB版(ApsaraDB for MongoDB)完全兼容MongoDB协议,基于飞天分布式系统和高可靠存储引擎,提供多节点高可用架构、弹性扩容、容灾、备份回滚、性能优化等解决方案。 产品详情: https://www.aliyun.com/product/mongodb
相关文章
|
8天前
|
监控 数据管理 测试技术
实现API接口的自动化
API接口自动化测试的最佳实践包括确定测试范围和目标、编写测试用例、选择合适的自动化测试工具、搭建测试环境、编写自动化测试脚本、执行自动化测试、分析测试结果和回归测试。通过这些步骤,可以提高测试效率和质量,确保API的稳定性和可靠性。此外,还介绍了如何利用API接口测试工具进行性能测试和压力测试,以及常见的挑战和解决方案。
|
4天前
|
JSON API 数据格式
淘宝 / 天猫官方商品 / 订单订单 API 接口丨商品上传接口对接步骤
要对接淘宝/天猫官方商品或订单API,需先注册淘宝开放平台账号,创建应用获取App Key和App Secret。之后,详细阅读API文档,了解接口功能及权限要求,编写认证、构建请求、发送请求和处理响应的代码。最后,在沙箱环境中测试与调试,确保API调用的正确性和稳定性。
|
8天前
|
安全 测试技术 API
如何实现API接口的自动化测试?
实现API接口的自动化测试涉及多个关键步骤:确定测试范围和目标、编写测试用例、选择自动化测试工具、搭建测试环境、编写测试脚本、执行测试、分析结果和回归测试。选择合适的工具和考虑团队熟悉度是成功的关键。常用工具包括Postman、JMeter和SoapUI。通过这些步骤和工具,可以有效提高测试效率和质量,确保API的稳定性和可靠性。
|
16天前
|
供应链 数据挖掘 API
电商API接口介绍——sku接口概述
商品SKU(Stock Keeping Unit)接口是电商API接口中的一种,专门用于获取商品的SKU信息。SKU是库存量单位,用于区分同一商品的不同规格、颜色、尺寸等属性。通过商品SKU接口,开发者可以获取商品的SKU列表、SKU属性、库存数量等详细信息。
|
17天前
|
JSON API 数据格式
店铺所有商品列表接口json数据格式示例(API接口)
当然,以下是一个示例的JSON数据格式,用于表示一个店铺所有商品列表的API接口响应
|
27天前
|
编解码 监控 API
直播源怎么调用api接口
调用直播源的API接口涉及开通服务、添加域名、获取API密钥、调用API接口、生成推流和拉流地址、配置直播源、开始直播、监控管理及停止直播等步骤。不同云服务平台的具体操作略有差异,但整体流程简单易懂。
|
7天前
|
JSON API 数据安全/隐私保护
拍立淘按图搜索API接口返回数据的JSON格式示例
拍立淘按图搜索API接口允许用户通过上传图片来搜索相似的商品,该接口返回的通常是一个JSON格式的响应,其中包含了与上传图片相似的商品信息。以下是一个基于淘宝平台的拍立淘按图搜索API接口返回数据的JSON格式示例,同时提供对其关键字段的解释
|
1月前
|
JSON JavaScript API
(API接口系列)商品详情数据封装接口json数据格式分析
在成长的路上,我们都是同行者。这篇关于商品详情API接口的文章,希望能帮助到您。期待与您继续分享更多API接口的知识,请记得关注Anzexi58哦!
|
17天前
|
JSON 前端开发 JavaScript
API接口商品详情接口数据解析
商品详情接口通常用于提供特定商品的详细信息,这些信息比商品列表接口中的信息更加详细和全面。以下是一个示例的JSON数据格式,用于表示一个商品详情API接口的响应。这个示例假定API返回一个包含商品详细信息的对象。
|
23天前
|
JSON API 开发者
1688API商品详情接口如何获取
获取 1688 API 商品详情接口的步骤包括:1. 注册开发者账号;2. 了解接口规范和政策;3. 申请 API 权限;4. 获取 API 密钥;5. 实现接口调用(选择开发语言、发送 HTTP 请求);6. 处理响应数据。通过这些步骤,可以顺利调用 1688 的商品详情 API。