npm 包 keystone-admin-routes 使用教程

阅读时长 5 分钟读完

简介

在前后端分离的开发模式下,管理后台常常是一个不可或缺的部分。使用 keystone.js 可以快速构建一个管理后台,而 keystone-admin-routes 则可以方便地扩展和定制后台的路由和页面。

本文将介绍 keystone-admin-routes 的安装及使用方法,以及使用场景和示例代码。

安装

使用 npm 安装 keystone-admin-routes:

使用方法

在 keystone 配置文件中,引入 keystone-admin-routes 和需要的模块。然后可以通过 adminRoutes.add 方法添加路由及页面。

示例代码:

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

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

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

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

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

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

其中,

  • add 方法的第一个参数是 keystone 实例;
  • 第二个参数是路由名称,也是用来生成 URL 的一部分;
  • 第三个参数是路由路径;
  • 第四个参数是对应的页面的文件名,也就是存放在 views 目录下的文件名。

添加路由后,可以在管理后台的底部导航菜单中看到对应的链接,点击后显示该页面。

使用场景

keystone-admin-routes 主要用于扩展和定制管理后台的路由和页面。

例如,在一个博客系统中,需要在管理后台添加一个页面用来显示所有文章的阅读量。可以通过 keystone-admin-routes 添加一个路由和页面,然后在该页面中查询数据库并展示数据。

示例代码:

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

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

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

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

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

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

在 views/article-views.pug 中,编写显示阅读量的代码,例如:

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

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

然后在 routes/index.js 中添加路由:

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

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

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

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

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

以上代码会查询数据库中的所有文章,并将阅读量显示在管理后台的该页面中。

总结

keystone-admin-routes 是一个方便的 keystone.js 扩展,可以快速添加自定义的路由和页面。上文介绍了安装及使用方法,以及使用场景和示例代码。

希望本文对您有所帮助,谢谢阅读!

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

纠错
反馈