{"info":{"_postman_id":"b9c32101-ead8-4420-92da-6a6b6f3fbcb5","name":"API DOCUMENTATION SAMPLE","description":"

Sample API Documentation

This collection contains sample requests.

It contains the following requests:

Register User
View one or all Users
Update User
Delete User
Create Question
View one or all Question
Update Question / Upvote or Downvote Questions
Delete Question
Create Answer
View one or all Answers
Update one or all Answers
Delete Answer
finally search for (user, answer and question).

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Sample API Documentation","slug":"sample-api-documentation"}],"owner":"6648981","collectionId":"b9c32101-ead8-4420-92da-6a6b6f3fbcb5","publishedId":"SWTD8wu2","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-02-02T11:16:00.000Z"},"item":[{"name":"http://localhost:3000/user/create","id":"c973856b-f060-426e-bb8c-2496d3a71368","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"firstname\" : \"Test\",\n \"middlename\" : \"Testing\",\n \"lastname\" : \"Testings\",\n \"email\" : \"test@email.com\",\n \"password\" : \"password\"\n}"},"url":"http://localhost:3000/user/create","description":"

Api endpoint to Register a User in the system:

A successful registration (POST request) will result in an HTTP 201 Status code.

A bad request will result in an HTTP 500 or 400 Status code

\n","urlObject":{"protocol":"http","port":"3000","path":["user","create"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"c973856b-f060-426e-bb8c-2496d3a71368"},{"name":"http://localhost:3000/user","id":"9064ac0c-6a60-4c53-82ec-720f0ff50b94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:3000/user","description":"

Api endpoint to view all the Usesr in the system:

A successful Get request will result in an HTTP 200 Status code.

A bad request will result in an HTTP 500 or *400 Status code

\n","urlObject":{"protocol":"http","port":"3000","path":["user"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"9064ac0c-6a60-4c53-82ec-720f0ff50b94"},{"name":"http://localhost:3000/user/userId","id":"73428dff-f40c-4f07-8224-195519174fb2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:3000/user/userId","description":"

Api endpoint to view one User in the system using the ID of the User:

A successful Get request will result in an HTTP 200 Status code.

A bad request will result in an HTTP 500 or 400 Status code

\n","urlObject":{"protocol":"http","port":"3000","path":["user","userId"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"73428dff-f40c-4f07-8224-195519174fb2"},{"name":"http://localhost:3000/user/update/userId","id":"93b23262-c886-4e6d-9021-57b4da2aa70c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"lastname\" : \"hello world\"\n}"},"url":"http://localhost:3000/user/update/userId","description":"

Api endpoint to Update one User in the system using the ID of the User:

A successful PUT request will result in an HTTP 200 Status code and a response

Message:** “User Updated successfully”**

A bad request will result in an HTTP 500 or 400 Status code and the error message

\n","urlObject":{"protocol":"http","port":"3000","path":["user","update","userId"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"93b23262-c886-4e6d-9021-57b4da2aa70c"},{"name":"http://localhost:3000/user/delete/userId","id":"79ec99ca-1210-4f9c-b46b-93b063972369","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"http://localhost:3000/user/delete/userId","description":"

Api endpoint to Delete one User in the system using the ID of the User:

A successful DELETE request will result in an HTTP 200 Status code and a response

Message:“User Deleted successfully”

A bad request will result in an HTTP 500 or 400 Status code and the error message

\n","urlObject":{"protocol":"http","port":"3000","path":["user","delete","userId"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"79ec99ca-1210-4f9c-b46b-93b063972369"},{"name":"http://localhost:3000/user/login","id":"b3db023d-8fd7-42a2-bc69-cb46e3167d03","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"email\": \"test@email.com\",\n\t\"password\": \"password\"\n}"},"url":"http://localhost:3000/user/login","description":"

Api endpoint used by registered users to login and generate token

A successful POST request will result in an HTTP 200 Status code and a response

Message:** “User loggedin successfully” **along with the generated Token . the Token is also sent to the header with name auth-token

A bad request will result in an HTTP 500 or 400 Status code and the error message

\n","urlObject":{"protocol":"http","port":"3000","path":["user","login"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"b3db023d-8fd7-42a2-bc69-cb46e3167d03"},{"name":"http://localhost:3000/user/logout","id":"6e8a4414-7d17-424a-832b-e34bf51d9e43","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"http://localhost:3000/user/logout","description":"

Api endpoint used by users to logout from the system\nNote: Just a placeholder but not fully implemented yet

\n","urlObject":{"protocol":"http","port":"3000","path":["user","logout"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"6e8a4414-7d17-424a-832b-e34bf51d9e43"},{"name":"http://localhost:3000/question/create","id":"1879c0fb-4dd3-4399-bd87-bd846215bf59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"auth-token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI1ZTM1YTZlY2IwNmUzYzI5NGU2MjQ4YmYiLCJpYXQiOjE1ODA1NzUxMDd9.dm910w6d0_ZWdLB2DDcMBarx5lVVSosiQnK4RmhXzaY","type":"text","description":"

You need to add this key auth-token and the token generated when you logged in to perform any post,put or delete operation or else the system will ask you to login

\n"}],"body":{"mode":"raw","raw":"{\n\t\"title\" : \"modified title\",\n \"question\" : \"Define SUBSCRIBE (verb) and get synonyms. What is SUBSCRIBE (verb)? SUBSCRIBE (verb) meaning, pronunciation and more by Macmillan Dictionary.\"\n}"},"url":"http://localhost:3000/question/create","description":"

Api endpoint for Creating Question in the system

**Note: **you need to add the auth-token key and token value to the header to perform this action

A successful POST request will result in an HTTP 201 Status code and a response

Message: “Question Created successfully” with created question

A bad request will result in an HTTP 500 or 400 or 401 Status code and the error message

\n","urlObject":{"protocol":"http","port":"3000","path":["question","create"],"host":["localhost"],"query":[{"disabled":true,"key":"auth-token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI1ZTM1YTZlY2IwNmUzYzI5NGU2MjQ4YmYiLCJpYXQiOjE1ODA1NzUxMDd9.dm910w6d0_ZWdLB2DDcMBarx5lVVSosiQnK4RmhXzaY"}],"variable":[]}},"response":[],"_postman_id":"1879c0fb-4dd3-4399-bd87-bd846215bf59"},{"name":"http://localhost:3000/question/questionId","id":"919a4b11-d15e-48f4-ae44-b58e6a75cb6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"auth-token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI1ZTM1YTZlY2IwNmUzYzI5NGU2MjQ4YmYiLCJpYXQiOjE1ODA1NzUxMDd9.dm910w6d0_ZWdLB2DDcMBarx5lVVSosiQnK4RmhXzaY","description":"

You need to add this key auth-token and the token generated when you logged in to perform any post,put or delete operation or else the system will ask you to login

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"title\":\"Test Title for update\"\n}"},"url":"http://localhost:3000/question/questionId","description":"

Api endpoint for Updating Question in the system

**Note: **you need to add the auth-token key and token to the header to perform this action

A successful PUT request will result in an HTTP 200 Status code and a response

Message: “Question Updated successfully” with Updated question

A bad request will result in an HTTP 500 or 400 or 401 Status code and the error message

\n","urlObject":{"protocol":"http","port":"3000","path":["question","questionId"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"919a4b11-d15e-48f4-ae44-b58e6a75cb6a"},{"name":"http://localhost:3000/question/questionId","id":"e36cc062-0c3c-4cc3-9427-aa477d008bb7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"auth-token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI1ZTM1YTZlY2IwNmUzYzI5NGU2MjQ4YmYiLCJpYXQiOjE1ODA1NzUxMDd9.dm910w6d0_ZWdLB2DDcMBarx5lVVSosiQnK4RmhXzaY","type":"text","description":"

You need to add this key auth-token and the token generated when you logged in to perform any post,put or delete operation or else the system will ask you to login

\n"}],"body":{"mode":"raw","raw":"{\n\t\"votequestion\":\"upvote\",\n\t\"subscribe\": true\n}"},"url":"http://localhost:3000/question/questionId","description":"

Api endpoint for Updating Question in the system using the question ID

Note: Just to demonstrate upvote or downvote and also subscribe to email

**Note: **you need to add the auth-token key and token to the header to perform this action

A successful PUT request will result in an HTTP 200 Status code and a response

Message: “Question Updated successfully” with Updated question

A bad request will result in an HTTP 500 or 400 or 401 Status code and the error message

\n","urlObject":{"protocol":"http","port":"3000","path":["question","questionId"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"e36cc062-0c3c-4cc3-9427-aa477d008bb7"},{"name":"http://localhost:3000/question/","id":"cf6fe20b-3c1c-469f-b6dc-27276e2c300c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:3000/question/","description":"

Api endpoint to VIEW all the questions in the system:

A successful GET request will result in an HTTP 200 Status code and a response

A bad request will result in an HTTP 500 or 400 Status code and the error message

\n","urlObject":{"protocol":"http","port":"3000","path":["question",""],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"cf6fe20b-3c1c-469f-b6dc-27276e2c300c"},{"name":"http://localhost:3000/question/questionId","id":"129b74a2-3cf2-4148-8178-a98f51e04762","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:3000/question/questionId","description":"

Api endpoint to VIEW one question in the system using the ID of the question:

A successful GET request will result in an HTTP 200 Status code and a response

A bad request will result in an HTTP 500 or 400 Status code and the error message

\n","urlObject":{"protocol":"http","port":"3000","path":["question","questionId"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"129b74a2-3cf2-4148-8178-a98f51e04762"},{"name":"http://localhost:3000/question/questionId","id":"98904baa-9f44-4a8e-8433-38c65b1d1c08","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"auth-token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI1ZTM1YTZlY2IwNmUzYzI5NGU2MjQ4YmYiLCJpYXQiOjE1ODA1NzUxMDd9.dm910w6d0_ZWdLB2DDcMBarx5lVVSosiQnK4RmhXzaY","type":"text","description":"

You need to add this key auth-token and the token generated when you logged in to perform any post,put or delete operation or else the system will ask you to login

\n"}],"url":"http://localhost:3000/question/delete/questionId","description":"

Api endpoint to Delete one question in the system using the ID of the question:

A successful DELETE request will result in an HTTP 200 Status code and a response

Message:** “Question Deleted successfully” **

A bad request will result in an HTTP 500 or 400 Status code and the error message

\n","urlObject":{"protocol":"http","port":"3000","path":["question","delete","questionId"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"98904baa-9f44-4a8e-8433-38c65b1d1c08"},{"name":"http://localhost:3000/answer/questionId","id":"aecaba5e-8b2e-4f0d-9442-15d9b8879405","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"auth-token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI1ZTM1YTZlY2IwNmUzYzI5NGU2MjQ4YmYiLCJpYXQiOjE1ODA1NzUxMDd9.dm910w6d0_ZWdLB2DDcMBarx5lVVSosiQnK4RmhXzaY","type":"text","description":"

You need to add this key auth-token and the token generated when you logged in to perform any post,put or delete operation or else the system will ask you to login

\n"}],"body":{"mode":"raw","raw":"{\n\t\"body\": \"Answered Question\"\n}"},"url":"http://localhost:3000/answer/questionId","description":"

Api endpoint for Answering a users Question in the system using the question ID

**Note: **you need to add the auth-token key and token to the header to perform this action

A successful POST request will result in an HTTP 201 Status code and a response

Message: “Thank you for your answer” with the amswer payload

A bad request will result in an HTTP 500 or 400 or 401 Status code and the error message

\n","urlObject":{"protocol":"http","port":"3000","path":["answer","questionId"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"aecaba5e-8b2e-4f0d-9442-15d9b8879405"},{"name":"http://localhost:3000/answer","id":"ff64d7da-4d2a-4740-ad7b-30e8e424970a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:3000/answer","description":"

Api endpoint for GETTING all answers in the system.

A successful GET request will result in an HTTP 200 Status code and a response

A bad request will result in an HTTP 500 or 400 Status code and the error message

\n","urlObject":{"protocol":"http","port":"3000","path":["answer"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"ff64d7da-4d2a-4740-ad7b-30e8e424970a"},{"name":"http://localhost:3000/answer/answerId","id":"be7371d4-c337-4ace-8295-7eac7d5336ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:3000/answer/answerId","description":"

Api endpoint for Getting one answer in the system using the ID of the answer:

A successful GET request will result in an HTTP 200 Status code and a payload

A bad request will result in an HTTP 500 or 400 Status code and the error message

\n","urlObject":{"protocol":"http","port":"3000","path":["answer","answerId"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"be7371d4-c337-4ace-8295-7eac7d5336ee"},{"name":"http://localhost:3000/answer/update/answerId","id":"35ee11ba-f651-4347-aea1-2c089fb7a4e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"auth-token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI1ZTM1YTZlY2IwNmUzYzI5NGU2MjQ4YmYiLCJpYXQiOjE1ODA1NzUxMDd9.dm910w6d0_ZWdLB2DDcMBarx5lVVSosiQnK4RmhXzaY","type":"text","description":"

You need to add this key auth-token and the token generated when you logged in to perform any post,put or delete operation or else the system will ask you to login

\n"}],"body":{"mode":"raw","raw":"{\n\t\"body\":\"Testing\"\n}"},"url":"http://localhost:3000/answer/update/answerId","description":"

Api endpoint for Updating one answer in the system using the ID of the answer:

A successful PUT request will result in an HTTP 200 Status code and a response

A bad request will result in an HTTP 500 or 400 Status code and the error message

\n","urlObject":{"protocol":"http","port":"3000","path":["answer","update","answerId"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"35ee11ba-f651-4347-aea1-2c089fb7a4e6"},{"name":"http://localhost:3000/answer/answerId","id":"a7a36ff4-414c-45d5-951e-a8b123927582","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"description":"

You need to add this key auth-token and the token generated when you logged in to perform any post,put or delete operation or else the system will ask you to login

\n","key":"auth-token","type":"text","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI1ZTM1YTZlY2IwNmUzYzI5NGU2MjQ4YmYiLCJpYXQiOjE1ODA1NzUxMDd9.dm910w6d0_ZWdLB2DDcMBarx5lVVSosiQnK4RmhXzaY"}],"body":{"mode":"raw","raw":""},"url":"http://localhost:3000/answer/delete/answerId","description":"

Api endpoint for Deleting an answer in the system using the answer ID

**Note: **you need to add the auth-token key and token to the header to perform this action

A successful DELETE request will result in an HTTP 200 Status code and a response

Message: “Answer deleted successfully”

A bad request will result in an HTTP 500 or 400 or 401 Status code and the error message

\n","urlObject":{"protocol":"http","port":"3000","path":["answer","delete","answerId"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"a7a36ff4-414c-45d5-951e-a8b123927582"},{"name":"http://localhost:3000/search?type=user&search=test@email.com","id":"59cbd698-62d4-48c4-9d42-2e6196d535eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:3000/search?type=user&search=test@email.com","description":"

Api endpoint for Searching any of the Schemas

Note: the type takes the name of the schema** user,question and answer** while search takes what you want to search. Eg . {type=user,search=name}, this will search for name in user schema;

A successful GET request will result in an HTTP 200 Status code and a response

A bad request will result in an HTTP 500 or 400 or 401 Status code and the error message

\n","urlObject":{"protocol":"http","port":"3000","path":["search"],"host":["localhost"],"query":[{"key":"type","value":"user"},{"key":"search","value":"test@email.com"}],"variable":[]}},"response":[],"_postman_id":"59cbd698-62d4-48c4-9d42-2e6196d535eb"}],"event":[{"listen":"prerequest","script":{"id":"c171a978-57ef-4c9c-b697-5e28bea21a47","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"23545ce5-577b-4f1a-b67e-2759ed724c5e","type":"text/javascript","exec":[""]}}]}