- Node.JS 8.0 and up
- git clone https://github.com/tarun-bathwal/sctask.git
- cd sctask
- npm install
- npm run make_env
- npm test
- npm start
- Base url : http://localhost:3000/ . All apis needed to be just appended to this url. For example : http://localhost:3000/api/login
- visit http://localhost:3000/api-docs to access the interactive swagger documentation.
- custom eslint configuration has been used as linter.
- 'npm run make_env' command makes a .env file which stores secret. This is only for development purpose and not for production
- 'npm test' shows code coverage using istanbul.js
- 'username' and 'password' are two string type required json payloads
- On success, it returns an object containing jwt token which should be sent along with other protected routes.
# PAYLOAD
{
"username":"user",
"password":"pass"
}
# OUTPUT
{
"success": true,
"message": "successfully logged in",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InVzZXIiLCJwYXNzd29yZCI6InBhc3MiLCJpYXQiOjE1Mzg5MzI2NDIsImV4cCI6MTUzOTAxOTA0Mn0.RH6OBojXMNfRHF6PB4u6fLWBsExzI3P2KApMwrrFW18"
}
- Payload contains 'doc' is a json while 'patch' is an array of objects.
- Set 'Authorization' Header as "Bearer token" where token is the same as obtained as payload after logging in. Token expires in 24hours.
- This applies the patch to the doc to give back the patched json.
# PAYLOAD
{
"doc" : {
"baz": "qux",
"foo": "bar"
},
"patch":[
{ "op": "replace", "path": "/baz", "value": "boo" },
{ "op": "add", "path": "/hello", "value": ["world"] },
{ "op": "remove", "path": "/foo" }
]
}
# OUTPUT
{
"success": true,
"message": "successfully patched the json object",
"patcheddoc": {
"baz": "boo",
"hello": [
"world"
]
}
}
- Payload contains 'url' as a string which is the public url of the image to be downloaded.
- Set 'Authorization' Header as "Bearer token" where token is the same as obtained as payload after logging in. Token expires in 24hours.
- Make sure the proxy is set/unset as required since it will fetch the image from a url.
- The image at url is resized to 50*50 pixels and sent back as response.
- visit this link in browser for interactive documentation enabled via swagger-ui.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent