Flotiq SDK NodeJS

SDK NodeJS

패키지 다운로드

Flotiq 대시보드에서 클라이언트 라이브러리 SDK NodeJS를 다운로드할 수 있는 링크를 찾을 수 있습니다.



이 패키지는 API 문서와 마찬가지로 콘텐츠 유형 정의를 수정할 때마다 자동으로 생성됩니다.

1. 설치

프로젝트에서 SDK를 사용하려면 다음 단계를 따르세요.

이 패키지의 압축을 풀고 [projectDirectory]/flotiq-javascript-sdk/로 이동합니다.

귀하의 [projectDirectory]/flotiq-javascript-sdk/ 실행 npm i && npm run build

귀하의 [projectDirectory] 실행 npm i ./flotiq-javascript-sdk --save다른 설치 방법은 #추가 사용 방법 섹션에 설명되어 있습니다.

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는 ElasticSearch 쿼리에 대한 래퍼인 강력한 검색 엔진을 제공합니다.

MediaApi: 미디어 파일을 업로드하거나 가져오기 위한 끝점입니다.

InternalApi: 사용자 정의 콘텐츠 정의를 반환, 삭제 또는 생성합니다

.

GraphQlApi: 헤드리스 유형에 대한 GraphQL 쿼리의 끝점

Content...Api: 자동으로 생성된 Content Type 정의에 대한 끝점

추가 사용 방법

지역 개발

이 패키지를 로컬 종속성으로 사용할 수도 있습니다. 원격 npm 레지스트리에 게시하거나 리포지토리에 커밋하지 않고 로컬에서 라이브러리를 사용하려면 먼저 package.json(및 이 README)이 포함된 디렉터리로 변경하여 종속성을 설치합니다. 이것을 JAVASCRIPT_CLIENT_DIR이라고 부르겠습니다. 그런 다음 다음을 실행합니다.
npm install
다음으로 JAVASCRIPT_CLIENT_DIR에서도 다음과 같이 npm에서 전역적으로 연결합니다.
npm link
프로젝트에서 방금 정의한 링크를 사용하려면 flotiq_user_api를 사용하려는 디렉터리로 전환하고 다음을 실행합니다.
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
마지막으로 모듈을 빌드해야 합니다.
npm run build