Todo fancy docs with external API For Quotes in Management and Career
GET {{serverurl}}/api
Test API Connection
Example: Success
GET {{serverurl}}/apiRequest
Response
Body
{ "message": "This API Works!" }
GET {{serverurl}}/api/auths
Checking if the api AUTH is exist
POST {{serverurl}}/api/auths/signup
Creating User with name, password and email
Header
Key Value Description Content-Type application/x-www-form-urlencoded Body
Key Value Type Description name yournamehere text New Username youremail@gmail.com text New Email password 123456 text password
Example: Create User- Success Response
POST {{serverurl}}/api/auths/signupRequest
Header
Key Value Description Content-Type application/x-www-form-urlencoded Body
Key Value Type Description name yournamehere text youremail@gmail.com text password 123456 text
Response
Body
{ "message": "success", "data": { "_id": "5b793b8bbfee5f380c3ea0a4", "name": "yournamehere", "userTodos": [], "created_at": "2018-08-19T09:42:35.148Z", "updated_at": "2018-08-19T09:42:35.148Z", "__v": 0, "password": "$2a$10$SH9x4tp4SzaBA1BWkcxPDO23sCfP.MTa0aDWvP5p44q86GMUb3S3y", "email": "youremail@gmail.com" } }
POST {{serverurl}}/api/auths/login
User Login with email and Password
Header
Key Value Description Content-Type application/x-www-form-urlencoded Body
Key Value Type Description youremail@gmail.com text user's email password 123456 text user's password
Example: User Login-Success
POST {{serverurl}}/api/auths/loginRequest
Header
Key Value Description Content-Type application/x-www-form-urlencoded Body
Key Value Type Description youremal@gmail.com text password 123456 text
Response
Body
{ "message": "Login Success", "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjViNzkzYjhiYmZlZTVmMzgwYzNlYTBhNCIsImlhdCI6MTUzNDY3MTgxOSwiZXhwIjoxNTM0NzU4MjE5fQ.oPaMkd2CMdRbEvE0osiHvB8t2x0KMWB5I17PwRNhUv0" }Example: User Login - Invalid Login
POST {{serverurl}}/api/auths/loginRequest
Header
Key Value Description Content-Type application/x-www-form-urlencoded Body
Key Value Type Description youremil@gmail.com text password 123456 text
Response
Body
{ "message": "Wrong Email or Password" }
POST {{serverurl}}/api/auths/verifytoken
to verify token in browser. each token lasted for 24 hours
Header
Key Value Description Content-Type application/x-www-form-urlencoded Body
Key Value Type Description token {{token}} text
Example: Verify Token - success
POST {{serverurl}}/api/auths/verifytokenRequest
Header
Key Value Description Content-Type application/x-www-form-urlencoded Body
Key Value Type Description token {{token}} text
Response
Body
{ "message": "OK", "data": { "name": "yournamehere" } }
GET {{serverurl}}/api/me
Seeing the whole user info with their Todos
Header
Key Value Description Content-Type application/x-www-form-urlencoded token {{token}} Body
Key Value Type Description token {{token}} text
Example: Success Response
GET {{serverurl}}/api/meRequest
Header
Key Value Description Content-Type application/x-www-form-urlencoded token {{token}} Body
Key Value Type Description token {{token}}
Response
Body
{ "message": "success", "data": { "_id": "5b78cf89ad978d6747f7d654", "name": "eri", "userTodos": [], "created_at": "2018-08-19T02:01:46.001Z", "updated_at": "2018-08-19T02:01:46.001Z", "__v": 0, "password": "$2a$10$DgKXNdO2HTN4XJSG3YcyDe5JE23z9yqMbBmlsVk/hh2GON2zcLOdq", "email": "joanlamrack@gmail.com" } }Example: Invalid Key
GET {{serverurl}}/api/meRequest
Header
Key Value Description Content-Type application/x-www-form-urlencoded token {{token}} Body
Key Value Type Description token {{token}} text
Response
Body
{ "message": "Invalid Signature" }
GET {{serverurl}}/api/me/todos
get all user todo
Header
Key Value Description token {{token}}
Example: Success Response
GET {{serverurl}}/api/me/todosRequest
Header
Key Value Description token {{token}} Token From registration
Response
Body
{ "message": "Todo Found", "data": [ { "title": "Belajar Hacktiv8", "notes": "restapi", "updated_at": "2018-08-19T03:51:40.090Z", "priority": "None", "__v": 0, "deadline": "2018-08-19T03:51:33.543Z", "_id": "5b78e94c75209e79bc71fe62", "created_at": "2018-08-19T03:51:40.090Z" } ] }Example: No Todo On User
GET {{serverurl}}/api/me/todosRequest
Header
Key Value Description token {{token}}
Response
Body
{ "message": "Todo empty" }
POST {{serverurl}}/api/me/todos
Create todo
Header
Key Value Description token {{token}} Content-Type application/x-www-form-urlencoded Body
Key Value Type Description title Belajar Hacktiv8 text notes restapi text
Example: Success Response
POST {{serverurl}}/api/me/todosRequest
Header
Key Value Description token {{token}} token from login Content-Type application/x-www-form-urlencoded Body
Key Value Type Description title Belajar Hacktiv8 text Title of Todo notes restapi text Note of Todo
Response
Body
{ "message": "todo successfully created", "data": { "title": "Belajar Hacktiv8", "notes": "restapi", "updated_at": "2018-08-19T03:51:40.090Z", "priority": "None", "__v": 0, "deadline": "2018-08-19T03:51:33.543Z", "_id": "5b78e94c75209e79bc71fe62", "created_at": "2018-08-19T03:51:40.090Z" } }
DELETE {{serverurl}}/api/me/todos/5b791254b650c7013f8a9375
delete todo by id
Header
Key Value Description token {{token}} Content-Type application/x-www-form-urlencoded
Example: Success Deleting
DELETE {{serverurl}}/api/me/todos/:todoIdRequest
Header
Key Value Description token {{token}} Content-Type application/x-www-form-urlencoded
Response
Body
{ "_id": "5b78cf89ad978d6747f7d654", "name": "eri", "userTodos": [ "5b791254b650c7013f8a9375" ], "created_at": "2018-08-19T02:01:46.001Z", "updated_at": "2018-08-19T06:46:44.700Z", "__v": 3, "password": "$2a$10$DgKXNdO2HTN4XJSG3YcyDe5JE23z9yqMbBmlsVk/hh2GON2zcLOdq", "email": "joanlamrack@gmail.com" }
PATCH {{serverurl}}/api/me/todos/:todoId
Update To Do from User by ID
Header
Key Value Description Content-Type application/x-www-form-urlencoded token {{token}} Body
Key Value Type Description priority High text title Hello text deadline text notes I'm learning for tommorow text
Example: Update with Multiple body parameters
PATCH {{serverurl}}/api/me/todos/5b792d70ac8b1a2efa5a6d77Request
Header
Key Value Description Content-Type application/x-www-form-urlencoded token {{token}} Body
Key Value Type Description priority High text None title Hello text String deadline text Date Format in string, see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date notes I'm learning for tommorow text String
Response
Body
{ "message": "To do Successfully Updated" }Example: Not Authorized
PATCH {{serverurl}}/api/me/todos/5b792d0ac8b1a2efa5a6d77Request
Header
Key Value Description Content-Type application/x-www-form-urlencoded token {{token}} Body
Key Value Type Description priority High text None title text String deadline text Date Format, see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date notes text String
Response
Body
{ "message": "Not Authorized" }Example: Success
PATCH {{serverurl}}/api/me/todos/5b792d70ac8b1a2efa5a6d77Request
Header
Key Value Description Content-Type application/x-www-form-urlencoded token {{token}} Token From Registration Body
Key Value Type Description priority High text None title text String deadline text Date Format, see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date notes text String
Response
Body
{ "message": "To do Successfully Updated" }
DELETE {{serverurl}}/api/me/
delete user's own account when logged in
Header
Key Value Description token {{token}} Content-Type application/x-www-form-urlencoded
GET {{serverurl}}/api/me/qod
Retriving data Quotes of the day from https://quotes.rest
Header
Key Value Description token {{token}}
Example: Success Response
GET {{serverurl}}/api/me/qodRequest
Header
Key Value Description token {{token}}
Response
Body
{ "contents": { "quotes": [ { "category": "management", "permalink": "https://theysaidso.com/quote/qpbyRnAKKtANQ4kMYtBulweF/mahatma-gandhi-the-history-of-the-world-is-full-of-men-who-rose-to-leadership-by", "tags": [ "history", "leadership", "management" ], "quote": "The history of the world is full of men who rose to leadership, by sheer force of self-confidence, bravery and tenacity.", "author": "Mahatma Gandhi", "length": "120", "background": "https://theysaidso.com/img/bgs/hang_on_building_top.jpg", "date": "2018-08-19", "title": "Management Quote of the day", "id": "qpbyRnAKKtANQ4kMYtBulweF" } ], "copyright": "2017-19 theysaidso.com" }, "success": { "total": 1 } }
Built with Postdown.
Author: Titor