npm 包 plank-client 使用教程

阅读时长 6 分钟读完

什么是 plank-client

Plank-client 是一个为后端开发者提供 API 前端调试工具的 npm 包,通过简单的配置即可在前端页面中发送请求并观察返回结果。它支持多种请求方式,包括 GET、POST、PUT、DELETE、PATCH、HEAD、OPTIONS。此外,它还具有请求挂起和取消、请求 URL 和请求头参数合并等实用功能。

如何安装 plank-client

在安装 plank-client 前,需要确保已经在您的项目中安装了 Node.js。然后,您可以使用以下命令在项目中安装 plank-client:

如何使用 plank-client

基本使用

发送 GET 请求

在发送 GET 请求时,您只需要提供请求的 URL 和请求头参数即可:

-- -------------------- ---- -------
------ ----------- ---- ---------------

----- ----------- - --- -------------
  -------- --------------------------
  -------- -
    -------------- ------- -------------------
  --
---

----- ------ - ----- -------------------------

通过表单发送 POST 请求

在发送 POST 请求时,您可以选择使用表单提交数据:

-- -------------------- ---- -------
------ ----------- ---- ---------------

----- ----------- - --- -------------
  -------- --------------------------
  -------- -
    -------------- ------- -------------------
  --
---

----- ------ - ----- ------------------------- -
  ----- -------
  ---- ---
---

通过 JSON 发送 POST 请求

您也可以选择使用 JSON 数据格式发送 POST 请求:

-- -------------------- ---- -------
------ ----------- ---- ---------------

----- ----------- - --- -------------
  -------- --------------------------
  -------- -
    -------------- ------- -------------------
    --------------- -------------------
  --
---

----- ------ - ----- ------------------------- -
  ----- -------
  ---- ---
---

发送 PUT 请求

发送 PUT 请求和发送 POST 请求类似:

-- -------------------- ---- -------
------ ----------- ---- ---------------

----- ----------- - --- -------------
  -------- --------------------------
  -------- -
    -------------- ------- -------------------
  --
---

----- ------ - ----- -------------------------- -
  ----- -------
  ---- ---
---

发送 DELETE 请求

发送 DELETE 请求时,您只需要提供请求的 URL 和请求头参数即可:

-- -------------------- ---- -------
------ ----------- ---- ---------------

----- ----------- - --- -------------
  -------- --------------------------
  -------- -
    -------------- ------- -------------------
  --
---

----- ------ - ----- ------------------------------

发送 PATCH 请求

发送 PATCH 请求和发送 PUT 请求类似:

-- -------------------- ---- -------
------ ----------- ---- ---------------

----- ----------- - --- -------------
  -------- --------------------------
  -------- -
    -------------- ------- -------------------
  --
---

----- ------ - ----- ---------------------------- -
  ----- -------
  ---- ---
---

高级使用

挂起请求

通过 plank-client,您可以挂起请求并稍后恢复。比如说,在您发送了一个 AJAX 请求并等待返回结果的时候,用户又希望取消该请求,则我们便可以通过挂起请求来实现:

-- -------------------- ---- -------
------ ----------- ---- ---------------

----- ----------- - --- -------------
  -------- --------------------------
  -------- -
    -------------- ------- -------------------
  --
---

----- ------- - -------------------------
------------------ -- ----

-- - ----
------------- -- -
  ----------------- -- ----
-- ------

-- --------
-----------------

合并请求 URL 和请求头参数

通过 plank-client,您可以将 baseURL、请求 URL 和请求头参数进行自动合并:

-- -------------------- ---- -------
------ ----------- ---- ---------------

----- ----------- - --- -------------
  -------- --------------------------
  -------- -
    -------------- ------- -------------------
  --
---

----- ------- - ---------------------
  ---- --------
  -------- -
    --------------- -------------------
  --
---

-- --- --------
-- ----- --- ------------------------------
-- ------------- -------------- ------- ------------------- --------------- ------------------ -

结语

Plank-client 是一款非常便捷的 API 前端调试工具,使用起来非常简单,并且功能十分实用。如果您需要在前端页面中调试后端 API,那么 plank-client 绝对是您不错的选择。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600553f581e8991b448d14c7

纠错
反馈