什么是 express-crud-api-swagger
express-crud-api-swagger 是一个 npm 包，它可以快速生成使用 Express 框架的 RESTful API，同时支持使用 Swagger 生成 API 文档。它采用了 CRUD 的设计模式，可以快速地创建 CURD API，提高了开发效率。
安装
安装 express-crud-api-swagger 之前，需要先在项目中安装 Express 和 Swagger：
npm install express --save npm install swagger-jsdoc --save npm install swagger-ui-express --save
然后使用 npm 安装 express-crud-api-swagger：
npm install express-crud-api-swagger --save
使用方法
使用 express-crud-api-swagger 创建 API，需要先通过配置文件来定义 API 的结构和参数。例如我们要创建一个闪购平台的商品 API：
-- -------------------- ---- -------
----- --------- - -
----- -
------ ------- -----
-------- --------
--
--------- ----
-------- --------
-------- -------- ---------
----------- -
---------------- -
----------- -
----- ---------
--- ---------
----- ----------------
--
--
--
----- -
-
----- -----------
------ -
--- -
----- ---------
-------- -----
-------------- -----
--
----- -
----- ---------
--------- -----
------- -----
--
------ -
----- ---------
--
------ -
----- ---------
--
----------- -
----- -------
--------- -----
-------- --------
--
----------- -
----- -------
--------- -----
-------- --------
--
--
---------- -
------- -
------- -------
----- ------------
----- -----
--
-------- -
------- ------
----- ------------
--
-------- -
------- ------
----- ----------------
--
------- -
------- ------
----- ----------------
----- -----
--
------- -
------- ---------
----- ----------------
----- -----
--
--
--
--
--以上配置文件定义了闪购平台商品 API 的相关信息，包括 API 的名称、版本号、基础路径、OpenAPI 版本、支持的通信协议和安全组件等等。在上面的配置文件中，我们定义了一个名为 products 的 API，包括增、删、改、查等操作。
接下来，我们需要使用 express-crud-api-swagger 生成闪购平台商品 API，代码如下：
-- -------------------- ---- -------
----- ------- - -------------------
----- --- - ----------
----- --------- - ------------------------------
----- ------------ - -------------------------
----- - --------------------- - - ------------------------------------
----- --------- - -
-- ---------
--
----- ------- - -
----- ------------------
------------------ ----------
--
----- ----- - ----------------------
-------------------- ---------------- ------------------------
------------------------------------------
----- ---- - ---------------- -- -----
---------------- -- -- ---------------------- -- ---- --------------在上述代码中，我们使用 swagger-jsdoc 生成 Swagger 文档，使用 swagger-ui-express 来展示 Swagger 文档。我们还使用 expressCrudApiSwagger 方法来生成 CURD API，然后将其附加到 Express 应用程序中。
现在，我们已经成功地创建了一个基于 Swagger 和 Express 的 CURD API，我们可以使用各种客户端工具，如 Postman，来测试我们的 API。
示例代码
在这里，我们提供了一个完整的 express-crud-api-swagger 示例应用程序，代码如下：
-- -------------------- ---- -------
----- ------- - -------------------
----- --- - ----------
----- --------- - ------------------------------
----- ------------ - -------------------------
----- - --------------------- - - ------------------------------------
----- --------- - -
----- -
------ -------- --- ---------
-------- --------
--
--------- ----
-------- --------
-------- ---------
----------- -
---------------- -
----------- -
----- ---------
--- ---------
----- ----------------
--
--
--
----- -
-
----- -----------
------ -
--- -
----- ---------
-------- -----
-------------- -----
--
----- -
----- ---------
--------- -----
------- -----
--
------ -
----- ---------
--
------ -
----- ---------
--
----------- -
----- -------
--------- -----
-------- --------
--
----------- -
----- -------
--------- -----
-------- --------
--
--
---------- -
------- -
------- -------
----- ----------------
----- -----
--
-------- -
------- ------
----- ----------------
------ -
------- -
----- ---------
--------- ------
--
--
--
-------- -
------- ------
----- --------------------
--
------- -
------- ------
----- --------------------
----- -----
--
------- -
------- ---------
----- --------------------
----- -----
--
--
--
--
--
----- ------- - -
----- ------------------
------------------ ----------
--
----- ----- - ----------------------
-------------------- ---------------- ------------------------
------------------------
---------------------------- --------- ---- ----
------------------------------------------
----- ---- - ---------------- -- -----
---------------- -- -- ---------------------- -- ---- --------------你可以将以上代码复制到你的项目中，然后使用以下命令启动该示例应用程序：
node app.js
总结
本文介绍了 npm 包 express-crud-api-swagger 的使用方法，它可以帮助开发人员快速创建基于 Express 和 Swagger 的 CURD API，提高了开发效率。我们还提供了一个完整示例应用程序来演示该 npm 包的使用。如果你需要创建 RESTful API，请务必尝试使用 express-crud-api-swagger。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6006737a890c4f727758414a