Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/monagoio/monagojs
SDK for monago platform, help developers to create and consume apis without managing the fullcode and its infrastructure
https://github.com/monagoio/monagojs
api api-generator cms dashboard erp headless-cms monagojs mongodb mysql rest
Last synced: 13 days ago
JSON representation
SDK for monago platform, help developers to create and consume apis without managing the fullcode and its infrastructure
- Host: GitHub
- URL: https://github.com/monagoio/monagojs
- Owner: monagoio
- License: mit
- Created: 2022-04-19T18:20:17.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-11-27T07:04:53.000Z (about 1 month ago)
- Last Synced: 2024-11-27T08:20:09.614Z (about 1 month ago)
- Topics: api, api-generator, cms, dashboard, erp, headless-cms, monagojs, mongodb, mysql, rest
- Language: TypeScript
- Homepage: https://monago.io
- Size: 563 KB
- Stars: 5
- Watchers: 4
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# MonagoJS - ⚡ Fast And Customized APIs Library From Monago.io
[](https://sonarqube.monago.io/dashboard?id=monagoio_monagojs_AYK1U5X5gSsHaZNf2KXx)
[](https://sonarqube.monago.io/dashboard?id=monagoio_monagojs_AYK1U5X5gSsHaZNf2KXx)
[](https://www.npmjs.org/package/@monagoio/monagojs)
[](https://npm-stat.com/charts.html?package=@monagoio/monagojs)
SDK for monago platform, help developers to create and consume apis without managing the fullcode and its infrastructure
**Note**: This library is only meant for usage from server-side with Monago secret API key.
For PCI compliance to be maintained, tokenization of apis url info should be done on client side with monago dashboard.
## Usage
First, you need to install the library
```bash
$ npm install @monagoio/monagojs
```
or
```bash
$ yarn add @monagoio/monagojs
```
Then, you create a project through Monago dashboard to get a **secretKey** to grant the access for the client application.
```js
import { MonagoClient } from '@monagoio/monagojs'
const client = new MonagoClient({
secretKey: "*******"
})
```
## How to Use
There are basic usages for developers to leverage Monago SDK such as register, login, create, read, update, delete. Remember, define you model and data through Monago dashboard.
### Example
#### Register
To use **register** function, you can pass your data such as below.
``` js
client.register({ email: "[email protected]", name : "monago", password: "pass" })
```
#### Login
To use **login** function, you can pass your data such as below.
``` js
client.login({ email : "monago", password: "pass" })
```
#### Create
To use **create** function, you can pass your data such as below.
``` js
client.post({ url: "/todos", data: {
"name": "Build an app",
"description": "Awesome apps ready to be released",
"date": "2022-05-18T08:51:52.031Z"
}})
```
#### Read All
To use **read all** function, you can write the code such as below.
``` js
client.get({ url: "/todos", params: {
"page": 1,
"limit": 10,
"orderby": "date"
}})
```
But, it depends whether you check the pagination option when you create the data model. If you uncheck the pagination, you can delete the params.
#### Read Detail
To use **read** function, you can write the code such as below.
``` js
client.get({ url: "/todos/:id" })
```
#### Update
To use **update** function, you can pass your data such as below.
```js
client.put({ url: "/todos/:id", data: {
"name": "[Postponed] Build an app",
"description": "Awesome apps ready to release",
"date": "2022-06-18T08:51:52.031Z"
}})
```
#### Delete
To use **delete** function, you can write the code such as below.
``` js
client.delete({ url: "/todos/:id" })
```
Remember, the URL depends on the model that you've defined.
#### Upload
To use **upload** function, you can write the code such as below.
``` js
client.upload({ url: "/upload" (optional), file, /folder/nama_file(optional)})
```