简介
在前端开发过程中，我们经常需要对后端 API 进行测试。为方便测试，前端社区中出现了许多优秀的测试框架和库，其中一个较为常用的是 @n3/ng-api-testing。该库提供了一些常用的 HTTP 方法和一些辅助方法，用于测试 Angular 应用中的 API。
安装
使用 @n3/ng-api-testing 需要先安装该库及其所需的依赖。
npm install @angular/platform-browser-dynamic @angular/common @angular/core @angular/forms @angular/http -D npm install @n3/ng-api-testing --save-dev
基本用法
@n3/ng-api-testing 提供了一些常用的 HTTP 方法，包括 get、post、put、patch 和 delete。
-- -------------------- ---- -------
------ - ---------------- - ---- ---------------------
---------------------------- -- -- -
--- ---------- -----------------
------------- -- -
--------- - --- -------------------
---
---------- ---- - --- --------- -- -- -
----- -------- - ------------------------------
--------------------------- -- -
-------------------------------------
--------------------------------------------
--------------------------------------------
---
---
---------- ---- - ---- --------- -- -- -
----- ----------- - - ----- ----- ----- ------ --------------------- --
----- -------- - ---------------------------- -------------
--------------------------- -- -
-------------------------------------
--------------------------------------------
------------------------------------------------ ------
-------------------------------------------------------------------
---
---
-- --- ----- ---- -------
---以上代码中，我们使用 ApiTesterService 创建一个 apiTester 实例，并使用其提供的方法进行 HTTP 请求。每个方法返回一个 Observable<ApiTesterResponse>，其中 ApiTesterResponse 包含了该请求的响应数据。
高级用法
除了常用的 HTTP 方法外，@n3/ng-api-testing 还提供了一些辅助方法，使我们的测试代码更简洁、易读。
setBaseUrl
默认情况下，@n3/ng-api-testing 发送的请求的基础 URL 是空字符串。但在实际开发中，有时需要在请求 URL 前面添加一定的前缀。
-- -------------------- ---- -------
------ - ---------------- - ---- ---------------------
---------------------------- -- -- -
--- ---------- -----------------
------------- -- -
--------- - --- -------------------
--------------------------------------------
---
---------- ---- - --- ------- ---- ---- ----- -- -- -
----- -------- - ------------------------------
--------------------------- -- -
-------------------------------------
--------------------------------------------
--------------------------------------------
---
---
---以上代码中，我们调用了 setBaseUrl 方法设置基础 URL 为 https://example.com。此后，我们每次调用 HTTP 方法时，该基础 URL 将被添加到请求的 URL 前面。
setHeader
如果我们的 API 带有一些特殊的 header，可以使用 setHeader 方法设置它们。该方法接收两个参数：header 名称和 header 值。
-- -------------------- ---- -------
------ - ---------------- - ---- ---------------------
---------------------------- -- -- -
--- ---------- -----------------
------------- -- -
--------- - --- -------------------
------------------------------------ ------- ------
---
---------- ---- - --- ------- ---- ------------- -------- -- -- -
----- -------- - ------------------------------
--------------------------- -- -
-------------------------------------
--------------------------------------------
--------------------------------------------
---
---
---以上代码中，我们调用了 setHeader 方法设置了 Authorization header。此后，我们每次调用 HTTP 方法时，该 header 将被添加到请求头中。
setQueryString
除了 header 外，有些 API 会使用查询参数。@n3/ng-api-testing 也可以很方便地设置这些查询参数。
-- -------------------- ---- -------
------ - ---------------- - ---- ---------------------
---------------------------- -- -- -
--- ---------- -----------------
------------- -- -
--------- - --- -------------------
---------------------------------- --------
---
---------- ---- - --- ------- ---- ----- -------- -- -- -
----- -------- - ----------------------------
--------------------------- -- -
-------------------------------------
--------------------------------------------
-------------------------------------------------------
-----------------------------------------------------
---
---
---以上代码中，我们调用了 setQueryString 方法设置了 sortBy=name 的查询参数。此后，我们每次调用 HTTP 方法时，该查询参数将被添加到请求 URL 的末尾。
小结
本文介绍了 @n3/ng-api-testing 的基本用法和高级用法。使用 @n3/ng-api-testing 可以使我们的 API 测试代码更简洁、易读和灵活。希望读者通过本文的介绍，能对该库有一个更清晰的认识，提高测试代码质量。完整的示例代码可访问 GitHub 仓库。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066bcc967216659e244843