简介
在前端开发中，我们通常会用到 Redux 作为状态管理工具，而 API 文档和服务器定义则会以 Swagger 规范进行定义。因此，我们需要一个工具能够将这些 API 文档自动管理为 Redux Store 中的同步状态。Redux-Swagger-Client 就是一个这样的工具。
安装
首先，我们需要将 Redux-Swagger-Client 安装到我们的项目中。
npm install redux-swagger-client --save
使用方法
接下来，我们需要编写配置文件告诉 Redux-Swagger-Client 如何访问我们的 API 文档。配置文件可以使用 YAML 或 JSON 格式编写。例如：
-- -------------------- ---- -------
--------
- ---- ------------------------------
------
-------------
----
---------
- ----------------
----------
------
------------ --- --------
-------
----- -------------------
------------
----
----- ------
-----------
---
----- -------
------- -----
---------
----- ------------------------
-----
----- ------
-------- ------之后，在我们的 Redux Store 中加载这个配置文件。例如：
-- -------------------- ---- ------- ------ - --------------- - ---- -------- ------ - ------------- - ---- ----------------------- ------ -------------- ---- ------------------------- ----- --------------- - ------------------------------ ----- -------- - ----------------- --------- --------------- --- ------ ------- ---------
现在，我们就可以在项目中使用 Redux-Swagger-Client 提供的 action 和 selector。例如：
-- -------------------- ---- -------
------ - --- - ---- -----------------------
------ - ------- - ---- --------------
----- --------------- - ------- -- -
------ -
---- -------------------------
--
--
----- --------- ------- --------------- -
------------------- -
-------------------------
------------ -------------
----- -
------ ---
-
----
-
-------- -
------ ---------------------------------
-
-
------ ------- ------------------------------------在这个例子中，我们首先加载了 Redux-Swagger-Client 提供的 get action 来请求 API，然后将返回的结果存储在 Redux Store 中。之后，我们可以使用 Redux 的 connect 函数将 store 中的 pet 属性传递给组件进行渲染。
结论
Redux-Swagger-Client 是一个可以让我们自动管理 API 文档为状态的工具。它可以让我们更好地使用 Redux 所提供的一些可预测性和可扩展性，同时还能提高我们的工作效率。如果您也正在使用 Swagger 规范来定义 API，那么 Redux-Swagger-Client 可能会很适合您。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6006700de361a36e0bce8c98