技术栈介绍
我不会后端的语言所以用express这个老框架来实现服务的搭建,主要是这个框架学习成本不高各种库也很多,社区大。(别说了,其实是不会别的)
express
nodemon
sequelize
swagger-jsdoc
swagger-ui-express
express
官网:express
官网介绍:基于 Node.js
平台,快速、开放、极简的 Web 开发框架。
这是一个老框架了,我喜欢这个框架是因为他使用起来非常简单,是的,非常简单。对我这种比较懒的人和学习能力比较差的人来说比较友好,简简单单几行代码就能完成一个api,很nice。
nodemon
npm:nodemon
npm介绍:nodemon
是一个通过在检测到目录中的文件更改时自动重新启动节点应用程序来帮助开发基于 Node.js 的应用程序的工具。
简单理解为热更新就可以了,跟vite,webpack一样的效果,使用简单,周下载量惊人,几乎用node开发服务端的同学都会使用这个npm包
sequelize
官网:sequelize
官网介绍:Sequelize
是一个基于 promise
的 Node.js ORM
, 目前支持 Postgres
, MySQL
, MariaDB
, SQLite
以 及 Microsoft
SQL
Server
. 它具有强大的事务支持, 关联关系, 预读和延迟加载,读取复制等功能。
怎么说呢,我之前没有怎么了解
ORM
,因为我写demo的时候都是写sql语句,然后用mysql
或者mysql2
来调用sql语句。这次选这个sequelize
也是看使用它来开发的同学很多,想学习一下。使用之后感觉还是很方便的,有很好的迁徙,模型同步,和操作数据库的很多api,对表的关联,非常的方便 一行sql语句都不用写,ORM
确实是偷懒神器,好用!
swagger-jsdoc
npm:swagger-jsdoc
npm介绍:该库读取您的JSDoc
注释的源代码并生成OpenAPI(Swagger)规范。
想想,前后端联调接口,怎么可以没有文档呢?它就可以很好的帮助我们,生成文档的json文件,就是在写
yaml
注释的过程中真的很折磨人,一个空格都有可能造成报错,暂时还没有想到更好的替代者,还请大佬推荐更好的方案。光是它还不能看到美丽的ui界面,要想看到完整的接口文档页面,就要请它的老伙计出场了。
swagger-ui-express
npm介绍:此模块允许您根据 文件提供 Express
自动生成的swagger-uiswagger.json
生成的 API 文档。结果是通过路由从 API 服务器托管的 API 的动态文档。
这就是
swagger-jsdoc
的老伙计啦,swagger-jsdoc
帮助我们把项目中的yaml
注释生成json文件,此模块将json文件渲染为界面,好让我们更清晰的浏览api。
以上罗列最重要的,有一些包再开发过程中也只会一步带过,就不一一介绍了。有疑问可联系博主一起探讨,或自行百度。