It helps you to use microCMS from JavaScript and Node.js applications.
Install npm package.
$ npm install microcms-js-sdk
or
$ yarn add microcms-js-sdkCDN support.
<script src="https://unpkg.com/microcms-js-sdk@latest/dist/umd/microcms-js-sdk.js"></script>First, create a client.
const { createClient } = require("microcms-js-sdk"); // CommonJS
import { createClient } from 'microcms-js-sdk'; //ES6
// Initialize Client SDK.
const client = createClient({
serviceDomain: "YOUR_DOMAIN", // YOUR_DOMAIN is the XXXX part of XXXX.microcms.io
apiKey: "YOUR_API_KEY",
// retry: true // Retry attempts up to a maximum of two times.
});When using with a browser.
<script>
const { createClient } = microcms;
// Initialize Client SDK.
const client = createClient({
serviceDomain: "YOUR_DOMAIN", // YOUR_DOMAIN is the XXXX part of XXXX.microcms.io
apiKey: "YOUR_API_KEY",
// retry: true // Retry attempts up to a maximum of two times.
// customFetcher: fetch.bind(globalThis), // Provide a custom `fetch` implementation as an option
});
</script>After, How to use get it below.
client
.get({
endpoint: 'endpoint',
queries: { limit: 20, filters: 'createdAt[greater_than]2021' },
})
.then((res) => console.log(res))
.catch((err) => console.error(err));
client
.get({
endpoint: 'endpoint',
contentId: 'contentId',
queries: { fields: 'title,publishedAt' },
})
.then((res) => console.log(res))
.catch((err) => console.error(err));And, Api corresponding to each content are also available. example.
// Get list API data
client
.getList({
endpoint: 'endpoint',
})
.then((res) => console.log(res))
.catch((err) => console.error(err));
// Get list API detail data
client
.getListDetail({
endpoint: 'endpoint',
contentId: 'contentId',
})
.then((res) => console.log(res))
.catch((err) => console.error(err));
// Get object API data
client
.getObject({
endpoint: 'endpoint',
})
.then((res) => console.log(res))
.catch((err) => console.error(err));This function can be used to retrieve all content IDs only.
Since filters and draftKey can also be specified, it is possible to retrieve only the content IDs for a specific category, or to include content from a specific draft.
The alternateField property can also be used to address cases where the value of a field other than content ID is used in a URL, etc.
client
.getAllContentIds({
endpoint: 'endpoint',
})
.then((res) => console.log(res))
.catch((err) => console.error(err));
// Get all content ids with filters
client
.getAllContentIds({
endpoint: 'endpoint',
filters: 'category[equals]uN28Folyn',
})
.then((res) => console.log(res))
.catch((err) => console.error(err));
// Get all content ids with draftKey
client
.getAllContentIds({
endpoint: 'endpoint',
draftKey: 'draftKey',
})
.then((res) => console.log(res))
.catch((err) => console.error(err));
// Get all content ids with alternateField
client
.getAllContentIds({
endpoint: 'endpoint',
alternateField: 'url',
})
.then((res) => console.log(res))
.catch((err) => console.error(err));This function can be used to retrieve all content data.
client
.getAllContents({
endpoint: 'endpoint',
})
.then((res) => console.log(res))
.catch((err) => console.error(err));
// with queries
client
.getAllContents({
endpoint: 'endpoint',
queries: { filters: 'createdAt[greater_than]2021', orders: '-createdAt' },
})
.then((res) => console.log(res))
.catch((err) => console.error(err));The following is how to use the write system when making a request to the write system API.
// Create content
client
.create({
endpoint: 'endpoint',
content: {
title: 'title',
body: 'body',
},
})
.then((res) => console.log(res.id))
.catch((err) => console.error(err));
// Create content with specified ID
client
.create({
endpoint: 'endpoint',
contentId: 'contentId',
content: {
title: 'title',
body: 'body',
},
})
.then((res) => console.log(res.id))
.catch((err) => console.error(err));
// Create draft content
client
.create({
endpoint: 'endpoint',
content: {
title: 'title',
body: 'body',
},
// Available with microCMS paid plans
// https://microcms.io/pricing
isDraft: true,
})
.then((res) => console.log(res.id))
.catch((err) => console.error(err));
// Create draft content with specified ID
client
.create({
endpoint: 'endpoint',
contentId: 'contentId',
content: {
title: 'title',
body: 'body',
},
// Available with microCMS paid plans
// https://microcms.io/pricing
isDraft: true,
})
.then((res) => console.log(res.id))
.catch((err) => console.error(err));// Update content
client
.update({
endpoint: 'endpoint',
contentId: 'contentId',
content: {
title: 'title',
},
})
.then((res) => console.log(res.id))
.catch((err) => console.error(err));
// Update object form content
client
.update({
endpoint: 'endpoint',
content: {
title: 'title',
},
})
.then((res) => console.log(res.id))
.catch((err) => console.error(err));// Delete content
client
.delete({
endpoint: 'endpoint',
contentId: 'contentId',
})
.catch((err) => console.error(err));If you are using TypeScript, use getList, getListDetail, getObject. This internally contains a common type of content.
// Type definition
type Content = {
text: string,
}
/**
* // getList response type
* {
* contents: Content[]; // This is array type of Content
* totalCount: number;
* limit: number;
* offset: number;
* }
*/
client.getList<Content>({ //other })
/**
* // getListDetail response type
* {
* id: string;
* createdAt: string;
* updatedAt: string;
* publishedAt?: string;
* revisedAt?: string;
* text: string; // This is Content type.
* }
*/
client.getListDetail<Content>({ //other })
/**
* // getObject response type
* {
* createdAt: string;
* updatedAt: string;
* publishedAt?: string;
* revisedAt?: string;
* text: string; // This is Content type.
* }
*/
client.getObject<Content>({ //other })The type of getAllContentIds is as follows.
/**
* // getAllContentIds response type
* string[] // This is array type of string
*/
client.getAllContentIds({ //other })Write functions can also be performed type-safely.
type Content = {
title: string
body?: string
}
client.create<Content>({
endpoint: 'endpoint',
// Since `content` will be of type `Content`, no required fields will be missed.
content: {
title: 'title',
body: 'body',
},
})
client.update<Content>({
endpoint: 'endpoint',
// The `content` will be of type `Partial<Content>`, so you can enter only the items needed for the update.
content: {
body: 'body',
},
})You can now use the fetch option of the Next.js App Router as CustomRequestInit. Please refer to the official Next.js documentation as the available options depend on the Next.js Type file.
const response = await client.getList({
customRequestInit: {
next: {
revalidate: 60,
},
},
endpoint: "endpoint",
});You can abort fetch requests.
const controller = new AbortController()
const response = await client.getObject({
customRequestInit: {
signal: controller.signal
},
endpoint: "config",
});
setTimeout(() => {
controller.abort()
}, 1000)const readClient = createClient({
serviceDomain: 'serviceDomain',
apiKey: 'readApiKey',
})
const writeClient = createClient({
serviceDomain: 'serviceDomain',
apiKey: 'writeApiKey',
})Apache-2.0