SDK nodejs

下载包裹

在您的Flotiq仪表板上，您可以找到链接以下载客户端库sdk nodejs。

每次修改内容类型定义时，这些软件包都会自动生成，就像API文档一样。

1.安装

在您的项目中使用SDK以下步骤：

1. 解压缩并将此包装移至[projectDirectory]/flotiq-javascript-sdk/
2. 在您的[projectDirectory]/flotiq-javascript-sdk/ run kude2中
3. 在您的[projectDirectory]中运行npm i ./flotiq-javascript-sdk --save 其他安装方法在#Additional使用方法部分中描述。

2.配置您的SDK

要初始化SDK，我们将使用FlotiqUserApi.ApiClient.init方法，该方法需要提供API_KEY值。

您的flotiq api_key位于Flotiq Dashboard中。如果您需要更多方向，请转到docs。

const FlotiqUserApi = require("flotiq_user_api");
FlotiqUserApi.ApiClient.init("API_KEY");

3.向Flotiq提出请求

let api = new FlotiqUserApi.ContentBlogAuthorApi();
let opts = {
  page: "1", // {Number} Listing page number, 1-based
  limit: "20", // {Number} Page limit
  orderBy: "internal.updatedAt", // {String} Order by field
  orderDirection: "asc", // {String} Order direction
  hydrate: "0", // {Number} Should hydrate relations of object, for now only one level of hydration is possible
  filters:
    '{"slug":{"type":"contains","filter":"test"},"title":{"type":"contains","filter":"test"}}', // {String} List filters
  ids: '["null"]', // {[String]} Ids of objects to return.
};
api.listFlotiqblogauthor(opts).then(
  function (data) {
    console.log("API called successfully. Returned data: " + data);
  },
  function (error) {
    console.error(error);
  }
);

4. SDK nodejs常见用例

FLOTIQ的主要概念是您的API规范从字面上表示您的一组内容定义。

可以使用：

• searchapi：Flotiq API提供了功能强大的搜索引擎，它是弹性搜索查询的包装器。
• MediaApi：上传或获取媒体文件的端点。
• internallapi：返回，删除或创建用户定义的内容定义
• GraphQlapi：无头类型的GraphQl查询端点
• 内容... API：自动生成内容类型定义的端点

其他用法方法

地方发展

您也可以将此软件包用作本地依赖关系。要在本地使用库，而无需发布到远程NPM注册表或对存储库进行投入，请首先通过更改包含包含package.json的目录（和此readme）来安装依赖项。我们称此javascript_client_dir。然后运行：

npm install

接下来，同样来自javascript_client_dir：

npm link

要使用您在项目中定义的链接，请切换到要使用flotiq_user_api的目录，然后运行：

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

最后，您需要构建模块：

npm run build