MBurger-JS-SDK
所属分类：云计算
开发工具：JavaScript
文件大小：258KB
下载次数：0
上传日期：2023-04-04 07:43:58
上 传 者：
sh-1993
说明： 这个包在JS项目和MBurger CMS之间提供了一个简单的接口，帮助您检索每个...
(This package provides a simple interface between your JS Project and the MBurger CMS, helping you to retrieve data easily. <https://mburger.cloud>)
文件列表:
.devcontainer (0, 2023-04-04)
.devcontainer\Dockerfile (839, 2023-04-04)
.devcontainer\devcontainer.json (982, 2023-04-04)
.prettierrc (25, 2023-04-04)
LICENSE (35148, 2023-04-04)
__tests__ (0, 2023-04-04)
__tests__\healthcheck.test.js (102, 2023-04-04)
__tests__\mburger.test.js (6851, 2023-04-04)
babel.config.js (110, 2023-04-04)
docs (0, 2023-04-04)
docs\MBurgerInstance-getBlock.html (9402, 2023-04-04)
docs\MBurgerInstance-getBlocks.html (7802, 2023-04-04)
docs\MBurgerInstance-getSection.html (8610, 2023-04-04)
docs\createClient.html (6728, 2023-04-04)
docs\index.html (3843, 2023-04-04)
docs\mburger.js.html (16218, 2023-04-04)
docs\scripts (0, 2023-04-04)
docs\scripts\app.min.js (1830, 2023-04-04)
docs\scripts\linenumber.js (675, 2023-04-04)
docs\scripts\search.js (1419, 2023-04-04)
docs\styles (0, 2023-04-04)
docs\styles\app.min.css (209749, 2023-04-04)
docs\styles\iframe.css (208, 2023-04-04)
docs\styles\prettify-jsdoc.css (1535, 2023-04-04)
docs\styles\prettify-tomorrow.css (2026, 2023-04-04)
docs\styles\reset.css (1021, 2023-04-04)
index.html (331, 2023-04-04)
jest.config.js (6584, 2023-04-04)
jsdoc.conf (134, 2023-04-04)
mburger.d.ts (1708, 2023-04-04)
mburger.js (19375, 2023-04-04)
mburger.ts (16158, 2023-04-04)
package-lock.json (582339, 2023-04-04)
package.json (806, 2023-04-04)
... ...
# ” MBurger JavaScript SDK ”
This package provides a simple interface between your Laravel Project and the MBurger CMS, helping you to retrieve data easily.
## 1.0 - Installation
This package can be installed via the most common Javascript package managers:
### 1.1 - NPM
```console
npm i mburger --save
```
### 1.1 - Yarn
```console
yarn add mburger --save
```
## 2.0 - Configuration
There is no need for configurations after installing the SDK.
## 3.0 - Methods reference
In the current version of our JS SDK you can find only a few methods that you can implement in your code but they're so powerful that enable you to do pretty anything with MBurger CMS.
### 3.1 - Initiate the connection
Init the connection to MBurger with your API Key.
```javascript
const instance = mburger.createClient({
api_key: '1234567890'
});
```
### 3.2 - Retrieve a single Section
| Specification | Data Type | Description |
|----------------|-----------------|-------------------------------------------------------------------------------------|
| section_id | Integer | ID of the requested Section |
| original_media | Boolean | Indicate if you want the original media or the converted ones |
| use_slug | Boolean | Declare if you want to use the section slug instead of the ID to retrieve data |
| locale | String | Country code of the required locale |
| size | `full`, `short` | Declare if you want the full response or the short version. The default is `short`. |
#### 3.2.1 - Sample code
```javascript
// Import MBurger SDK
const mburger = require('mburger');
// Init the connection
const instance = mburger.createClient({
api_key: '1234567890'
});
// Get a specific block
instance.getSection({
section_id: 10088,
locale: 'it',
original_media: false
}).then(result => console.log(result));
```
### 3.3 - Retrieve a Block's section
| Specification | Data Type | Description |
|-----------------------|-----------------|---------------------------------------------------------------------------------------------------------------|
| block_id | Integer | ID of the requested Block |
| force_locale_fallback | Boolean | Set the parameters force_locale_fallback as indicated in the documentation |
| locale | String | Country code of the required locale |
| original_media | Boolean | Indicate if you want the original media or the converted ones |
| params | Object | The parameters you want to pass to the MBurger params variable. Check our API Reference for more informations |
| order_asc | Boolean | Declare if you want the data in ascendent or descendent order |
| size | `full`, `short` | Declare if you want the full response or the short version. The default is `short`. |
#### 3.3.1 - Sample code
```javascript
// Import MBurger SDK
const mburger = require('mburger');
// Init the connection
const instance = mburger.createClient({
api_key: '1234567890'
});
// Retrieve a specific block's sections
instance.getSections({
block_id: 884,
locale: 'it',
original_media: false
}).then(result => console.log(result));
```
### 3.4 - Retrieve multiple Blocks
| Specification | Data Type | Description |
|---------------|-----------------|------------------------------------------------------------------------------------------------------------|
| block_ids | Array | ID of the requested Blocks |
| filters | Object | The filters you want to pass to the MBurger params variable. Check our API Reference for more informations |
| order_asc | Boolean | Declare if you want the data in ascendent or descendent order |
| size | `full`, `short` | Declare if you want the full response or the short version. The default is `short`. |
#### 3.4.1 - Sample code
```javascript
// Import MBurger SDK
const mburger = require('mburger');
// Init the connection
const instance = mburger.createClient({
api_key: '1234567890'
});
// Retrieve data from the block
instance.getBlocks({
block_ids: [884, 886],
locale: 'it'
}).then(result => console.log(result));
```
## 4.0 - Support & Feedback
For support regarding MBurger, the SDK or any kind of feedback please feel free to contact us via [support.mburger.cloud](http://support.mburger.cloud/)
## 5.0 - License
The MIT License (MIT). Please see [License File](./LICENSE) for more information.
近期下载者：
相关文件：
收藏者：