npm包 kentico-cloud-delivery-js-sdk-symbio 使用教程

前言

在前端开发中,我们常常需要从服务端获取数据来渲染页面,为此,一些CMS(Content Management System)提供了API供开发者使用。Kentico Cloud便是一款基于云端的CMS。

在这篇文章中,我们将介绍如何使用npm包 kentico-cloud-delivery-js-sdk-symbio来与Kentico Cloud交互。本文将详细介绍该npm包的使用方法,并提供一些示例代码。

安装

首先,我们需要安装kentico-cloud-delivery-js-sdk-symbio。可以使用npm进行安装:

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

使用

  1. 引入npm包

在JS文件中,我们需要引入kentico-cloud-delivery-js-sdk-symbio:

----- --- - ------------------------------------------------
  1. 创建DeliveryClient

在使用kentico-cloud-delivery-js-sdk-symbio之前,我们需要创建一个DeliveryClient对象:

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

请将<project_id>替换成您的项目ID。

  1. 获取内容

现在我们可以使用deliveryClient获取我们在Kentico Cloud CMS中创建的内容:

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

上述代码中,我们告诉deliveryClient来获取article类型的内容,然后创建一个Subscription对象,当内容返回时触发。您可以根据需要在callback中使用response对象。

深入理解

在上面的示例中,我们简单地使用DeliveryClient获取内容。下面我们将深入了解该npm包的更多细节和一些如何使用它的方法。

查询

在Kentico Cloud CMS中,内容是以Items的形式存在的。我们使用kentico-cloud-delivery-js-sdk-symbio时,我们将使用Items操作。

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

获取指定Item

要获取指定的Item,我们可以使用其codename或ID。

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

或者

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

指定类型

我们可以指定在查询中要返回的Items的类型。

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

在上面的示例中,我们将返回类型为article的Items。如果未指定类型,则将返回所有类型的Items。

查询字符串

我们还可以在查询中使用各种查询参数。接下来,我们将介绍其中一些参数。

limit

我们可以使用“limit”查询参数限制返回的条目数量。

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

在上述示例中,我们限制返回10条Items。

order

我们可以使用“order”查询参数来指定如何排序Items。以下示例将Items按发布日期排序:

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

在上哪个示例中,我们使用“publish_date”元素进行排序。

offset

我们可以使用“offset”查询参数来指定起始查询的位置。以下示例从第六条Items开始查询:

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

注意:查询参数的完整列表可以在Kentico Cloud的API文档中查看。

Elements

在Kentico Cloud CMS中,Item由一系列字段或元素组成。

我们可以使用kentico-cloud-delivery-js-sdk-symbio获取Item中的特定元素。

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

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

在此示例中,我们仅保留“title”,“description”和“date”元素。此代码行仅返回这些元素,仅这些元素将存储在response.items数组中。如果不指定此参数,则所有元素都将返回。

Taxonomy

在Kentico Cloud CMS中,Taxonomy是一组以分类方式组织的Item。

我们同样可以使用kentico-cloud-delivery-js-sdk-symbio来获取和查询taxonomy。

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

在上述代码中,我们请求名为“tags”的Taxonomy。请注意,此示例中的名称不区分大小写。

Asset

在Kentico Cloud CMS中,Asset是指任何类型的媒体文件。我们可以获取和操作媒体文件。

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

在此示例中,我们返回所有Asset。如果需要,您可以添加其他查询参数,例如下面的示例:

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

上述代码中,我们将只返回“image”类型的Asset,按大小进行了排序,并限制了返回项的数量。

示例代码

获取指定Item

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

获取所有Item

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

获取指定Asset

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

结论

在这篇文章中,我们深入介绍了npm包kentico-cloud-delivery-js-sdk-symbio的使用方法。通过使用该npm包,您可以轻松地获取您Kentico Cloud CMS中的内容,并与之交互。

希望这篇文章对您有所帮助,希望您可以在实际应用中享受到其便利。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/600672683660cf7123b365e2


猜你喜欢

  • npm 包 incentro-adf-msoffice-module 使用教程

    1. 前言 incentro-adf-msoffice-module 是一个基于 Node.js 的 npm 包,用于在 Alfresco Content Services 中集成 Microsoft...

    4 年前
  • npm 包 discord-bans 使用教程

    简介 discord-bans 是一个基于 Discord API 的 npm 包,用于管理和查询已经被禁止进入 discord 服务器的用户。它可以获取所有已经被删除的用户,查看所有用户的禁言状态,...

    4 年前
  • npm 包 ucarui-theme-chalk 使用教程

    前言 在开发 Web 前端界面时,样式是一个十分重要且需要面对的问题。为了方便统一样式风格,并实现一定的定制化,许多 UI 框架都会提供自定义主题的功能。 在此基础上,我们介绍一种基于 Vue.js ...

    4 年前
  • npm 包 ace-scripts 使用教程

    前言 近年来,随着前端技术的迅猛发展,前端项目的工程化、自动化已经成为了一种必需品。而 npm 包作为前端项目的重要组成部分,无论是开源库还是开发工具,都在不断涌现。

    4 年前
  • npm 包 @gothbarbie/data-type-tool-belt 使用教程

    简介 @gothbarbie/data-type-tool-belt 是一个针对 JavaScript 数据类型的工具包,提供了丰富的方法和函数,可以大大方便前端工程师处理数据类型相关问题。

    4 年前
  • npm 包 ucarui 使用教程

    前言 在前端开发中,我们常常需要使用各种 UI 组件,以提高开发效率并提供良好的用户体验。而 ucarui 是一个优秀的 UI 组件库,提供了丰富的组件及组件样式库,适用于各种 Web 应用的开发。

    4 年前
  • npm 包 package-json-sorter 使用教程

    简介 在前端项目中,使用 npm 包管理器进行依赖包的安装是非常常见的操作。而对于那些使用大量依赖包的项目来说,可能会遇到一个问题:依赖包在 package.json 文件中的顺序混乱,这会导致阅读和...

    4 年前
  • npm 包 package-json-sorter-cli 使用教程

    前言 在前端开发中,我们经常需要管理和维护项目依赖关系。而 npm(Node.js 的包管理器) 便是我们经常使用的依赖包管理工具,可用于发布、安装、卸载和搜索各种 JavaScript 模块。

    4 年前
  • npm 包 switch-writable 使用教程

    前言 在前端开发中,我们经常会遇到需要传递一些参数或者数据的情况,而这些数据可能会因为不同的环境或者不同的目的而需要不断地修改。为了方便我们进行数据的传递和修改,一些开发者就创建了一些 npm 包来帮...

    4 年前
  • npm包@webcomputing/tslint-config-webcomputing使用教程

    在前端开发中,代码质量和规范是十分重要的。tslint可以帮助我们在代码的规范性和一致性上提供一定的帮助。本文将介绍@webcomputing/tslint-config-webcomputing包的...

    4 年前
  • npm 包 @vutr/react-coverflow 使用教程

    前言 在前端开发中,图片展示是经常会用到的一种功能。而 coverflow 是一种比较炫酷的展示方式,可以让用户更好地浏览图片。而使用 npm 包 @vutr/react-coverflow 可以很方...

    4 年前
  • npm 包 shine-office-module 使用教程

    在前端开发过程中,我们经常需要处理 Excel 文档、Word 文档等办公文档。而 Shine 的 Office 模块则提供了一种简单易用的方法来处理这些文档。本文将介绍如何使用 npm 包 shin...

    4 年前
  • npm 包 auth0-get-all-users 使用教程

    介绍 auth0-get-all-users 是一个可以使用 Node.js 调用 Auth0 API 获取用户列表的 npm 包。它支持以分页方式获取所有用户信息,同时提供了过滤和排序的功能。

    4 年前
  • npm 包 kodi-addon-builder 使用教程

    前言 在制作 Kodi 插件的过程中,我们需要进行很多繁琐的工作,包括写 XML 文件、处理图像资源、搭建环境等等。这显然会消耗开发者大量精力与时间。因此,本文将介绍一款名为 kodi-addon-b...

    4 年前
  • npm 包 san-webpack-loader 使用教程

    简介 san-webpack-loader 是一个 Webpack 的 Loader 插件,用于编译 San 组件。 San 是腾讯的 MVVM 前端框架,与 Vue 和 React 类似,但其中有一...

    4 年前
  • npm 包 pdfmerge-cli 使用教程

    PDF 文件是很常见的一种文档格式,但是如果需要将多个 PDF 文件合并成一个,手动操作就非常繁琐。而 pdfmerge-cli 可以通过命令行工具来实现 PDF 文件的合并,非常方便快捷。

    4 年前
  • npm 包 omtv-react-main-menu-item 使用教程

    前言 在使用 React 开发 Web 应用时,常常需要实现一个主菜单组件,用于导航不同页面或模块。omtv-react-main-menu-item 就是一个轻量级、易于使用和扩展的 React 主...

    4 年前
  • npm 包 @iancarv/schm 使用教程

    简介 @iancarv/schm 是一个 JavaScript 对象验证和转换工具。它提供了一个现代、简单、灵活且可扩展的方法来定义和验证 JavaScript 对象的结构。

    4 年前
  • npm 包 forkback 使用教程

    在前端开发中,我们常常需要使用到不同的第三方库和框架来加速和简化我们的开发工作。而 npm(node package manager)作为全球最大的开源库生态系统,可以为我们提供大量开源组件、插件和库...

    4 年前
  • npm 包 pan_zagloba 使用教程

    介绍 pan_zagloba 是一个用于帮助开发者在前端应用中处理并发请求的 npm 包。它以 Promise 为基础,采用了像 RxJS 这样的响应式编程(Reactive Programming)...

    4 年前

相关推荐

    暂无文章