npm 包 @n3/ng-api-classifier-save 使用教程

阅读时长 5 分钟读完

简介

@n3/ng-api-classifier-save 是一个基于 Angular 和 TypeScript 的 npm 包,可以帮助前端工程师对 API 进行分类保存。该包可以使得保存 API 变得更加方便和易于管理。

使用步骤

  1. 安装 @n3/ng-api-classifier-save 包
  1. 导入 NgApiClassifierSave 模块

在 app.module.ts 文件中导入模块:

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

-----------
  ------------- ------
  -------- -
    --------------
    -------------------- -- -- ------------------- --
  --
  ---------- ------
  ---------- --------------
--
------ ----- --------- - -
  1. 创建分类结构

在 src/app 目录下创建 api 目录,并在该目录下创建分类结构,例如:

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

需要注意的是,结构的最终层级需要包含如下形式的 export:

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

-- --------
------ - ---- ----------------------
------ - ---- ----------------------
------ - ---- -------------------------
------ - ---- ----------------
------ - ---- -------------------
------ - ---- -------------------
  1. 在组件中使用

在组件中使用分类结构,例如:

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

------------
  --------- -----------
  ------------ -----------------------
  ---------- ------------------------
--
------ ----- ------------ -
  ------------
    ------- ----------- --------------------
  - -
    ----- --- - -------------------------------------------
    ----------------
  -
-
  1. 分类完成

const api = this.classifier.classify(['/api/index.ts']) 的返回值就是分类好的 API 结构。可以在 console 中查看 log 输出。

示例代码

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

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

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

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

总结

通过学习本教程,你已经了解了如何在 Angular 项目中使用 @n3/ng-api-classifier-save,以及如何创建 API 的分类结构并使用该包实现分类保存。你可以通过实际运用此包来提高自己对于 API 的管理能力。

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

纠错
反馈