8000 grial/connector-rest at master · sergiodxa/grial · GitHub
[go: up one dir, main page]
Skip to content
This repository was archived by the owner on Dec 2, 2017. It is now read-only.

Latest commit

 

History

History

connector-rest

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
index.js
index.js
 
 
package.json
package.json
 
 
yarn.lock
yarn.lock
 
 

README.md

@grial/connector-rest

Grial datasource connector for wrapping Rest APIs.

Required enviroment variables

  • REST_ENDPOINT => the base endpoint to your Rest API

Usage

Install it

npm i @grial/connector-rest

Add it to your connectors.js files

exports.rest = require('@grial/connector-rest')

API

create({ resource: string, data: Object, params: Object = {}, headers: Object = {} }): any

Create a new resource with the received data

read({ resource: string, id: any = null, params: Object = {}, headers: Object = {} }): any

Fetch a single resource or a list of resources (if the ID is not provided).

update({ resource: string, id: any, data, params: Object = {}, headers: Object = {} }): any

Create a resource with the specified data

delete({ resource: string, id: any = null, params: Object = {}, headers: Object = {} }): any

Delete a specific resource
0