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
相关文章
|
5天前
|
机器人 API Python
智能对话机器人(通义版)会话接口API使用Quick Start
本文主要演示了如何使用python脚本快速调用智能对话机器人API接口,在参数获取的部分给出了具体的获取位置截图,这部分容易出错,第一次使用务必仔细参考接入参数获取的位置。
|
3天前
|
XML JSON API
RESTful API设计最佳实践:构建高效、可扩展的接口
【8月更文挑战第17天】RESTful API设计是一个涉及多方面因素的复杂过程。通过遵循上述最佳实践,开发者可以构建出更加高效、可扩展、易于维护的API。然而,值得注意的是,最佳实践并非一成不变,随着技术的发展和业务需求的变化,可能需要不断调整和优化API设计。因此,保持对新技术和最佳实践的关注,是成为一名优秀API设计师的关键。
|
4天前
|
监控 API 数据安全/隐私保护
​邮件API触发式接口分析?邮件API接口好评榜
邮件API在企业通信和营销中至关重要,通过自动化邮件发送流程提升效率与客户满意度。本文解析邮件API触发式接口,即基于特定事件(如用户注册、购买产品)自动发送邮件的技术,能显著加快企业响应速度并增强用户体验。推荐市场上的优秀邮件API产品,包括SendGrid、Mailgun、Amazon SES、Postmark及新兴的AOKSend,它们各具特色,如高发送率、详细分析工具、灵活配置、强大的日志功能及用户友好的API接口,帮助企业根据不同需求选择最合适的邮件API解决方案。
|
11天前
|
存储 算法 Oracle
19 Java8概述(Java8概述+lambda表达式+函数式接口+方法引用+Stream+新时间API)
19 Java8概述(Java8概述+lambda表达式+函数式接口+方法引用+Stream+新时间API)
39 8
|
21天前
|
开发框架 前端开发 JavaScript
循序渐进VUE+Element 前端应用开发(13)--- 前端API接口的封装处理
循序渐进VUE+Element 前端应用开发(13)--- 前端API接口的封装处理
|
25天前
|
缓存 监控 测试技术
API设计与开发的最佳实践:打造高效、易用的接口服务
【7月更文挑战第26天】API的设计与开发是一个复杂而重要的过程,它直接影响到系统的可用性和用户体验。通过遵循上述最佳实践,开发者可以构建出高效、易用、可扩展的接口服务,为不同软件和服务之间的集成提供有力支持。在未来的软件开发中,API将扮演越来越重要的角色,因此不断学习和实践API设计与开发的最佳实践,对于开发者来说至关重要。
|
19天前
|
开发框架 前端开发 API
使用代码生成工具快速开发应用-结合后端Web API提供接口和前端页面快速生成,实现通用的业务编码规则管理
使用代码生成工具快速开发应用-结合后端Web API提供接口和前端页面快速生成,实现通用的业务编码规则管理
|
21天前
|
开发框架 前端开发 关系型数据库
使用egg.js开发后端API接口系统 什么是Egg.js
使用egg.js开发后端API接口系统 什么是Egg.js
|
26天前
|
API 开发者 Python
淘宝商品详情API接口开发实战
在电商领域,获取淘宝商品详情是关键需求。需先注册淘宝开放平台账号并创建应用,获取AppKey与AppSecret;随后申请商品服务API权限。利用Python,通过AppKey和AppSecret获取Access Token,进而调用商品详情API,需替换示例代码中的`your_app_key`, `your_app_secret`, `your_access_token`, 和`item_id`。注意遵守平台限制,处理可能的错误及合理规划调用策略以避免违规。[示例代码](https://)展示了从获取Access Token到调用商品详情API的全过程。
|
27天前
|
存储 API 文件存储