This document describe various endpoints in this recipe Api to enable easy navigation and accessibility
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"13808583","collectionId":"15dad333-80e8-4c7d-8f3e-a89d774f557c","publishedId":"UVXesdfk","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-01-09T21:01:58.000Z"},"item":[{"name":"User","item":[{"name":"Sign Up","id":"d85721fb-e942-4047-ad85-499743098063","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"fullname\": \"chinedu ogunmakin\",\n \"email\" : \"ogunmakin@gmail.com\",\n \"password\" : \"test1234\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}users/signup","description":"This is the signup endpoint. The user uses this endpoint to create an account. It is a post Request which allows three input fields.
\nAn access token is generated as soon as the user create an account.
\n","urlObject":{"path":["signup"],"host":["{{URL}}users"],"query":[],"variable":[]}},"response":[],"_postman_id":"d85721fb-e942-4047-ad85-499743098063"},{"name":"Sign In","id":"5d193f3a-69d0-4369-94e5-a940fc637a68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\" : \"ogunmakin@gmail.com\",\n \"password\" : \"test1234\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}users/login","description":"This is the signin endpoint. The user uses this endpoint to login to an account. It is a post Request which allows two input fields.
\nAn access token is generated as soon as the user logs into the account and this token gives access to protected routes which requires Authorization
\n","urlObject":{"path":["login"],"host":["{{URL}}users"],"query":[],"variable":[]}},"response":[],"_postman_id":"5d193f3a-69d0-4369-94e5-a940fc637a68"},{"name":"logOut","id":"8fd12c30-1d1c-40f7-ae2d-817bc3005ac0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{URL}}users/logout","description":"This is the signOut endpoint. The user uses this endpoint to logout of an account. It is a get Request that rescinds the authorization the access token provides
\n","urlObject":{"path":["logout"],"host":["{{URL}}users"],"query":[],"variable":[]}},"response":[],"_postman_id":"8fd12c30-1d1c-40f7-ae2d-817bc3005ac0"}],"id":"f87f1ec7-08bd-4d92-a27d-5d2b29737c3f","description":"The User folder contains three endpoints which includes endpoints to create a user account/signup, another to signIn and the last to log-out user
\n","_postman_id":"f87f1ec7-08bd-4d92-a27d-5d2b29737c3f"},{"name":"Recipe","item":[{"name":"Create a Recipe","id":"704daccc-4b71-4133-8976-0337e250f85c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\" : \"fried rice\",\n \"meal_type\" : \"lunch\",\n \"difficulty_level\": \"beginner\",\n \"ingredients\": [{\"name\":\"onions\", \"price\":\"50\"}, \n {\"name\": \"4 cups of rice\", \"price\":\"3000\"}],\n \"preparation\": \"Boil the water for 10mins, rinse the rice, fry the pepper, add salt, maggi and pepper\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}recipes","description":"This is the create recipe endpoint. This endpoint is a protected endpoint which means only logged in user can create a recipe. The user uses this endpoint to create an account. It is a post Request which inputs according to the schema provided by the recipe schema. Each created recipe will reference the User that created it. The schema model will be shown below;
\n","urlObject":{"host":["{{URL}}recipes"],"query":[],"variable":[]}},"response":[],"_postman_id":"704daccc-4b71-4133-8976-0337e250f85c"},{"name":"Get All Recipes","id":"43176beb-1382-4982-9905-1d962328bc29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{URL}}recipes","description":"This is the getAll recipe endpoint. This endpoint is a protected endpoint which means only logged in user can see all recipe document. the total number of recipe is found in the result which is one of the keys in the response
\n","urlObject":{"host":["{{URL}}recipes"],"query":[],"variable":[]}},"response":[],"_postman_id":"43176beb-1382-4982-9905-1d962328bc29"},{"name":"getAllRecipebyUser","id":"b0f1683e-0640-477c-b80c-6832060723aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"b0f1683e-0640-477c-b80c-6832060723aa"},{"name":"getOneRecipebyUser","id":"87d9fa33-476b-4912-a674-190d521b5035","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"87d9fa33-476b-4912-a674-190d521b5035"},{"name":"Get Paginated Recipes","id":"ead6ce95-4bf4-4904-9474-8601e932b716","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{URL}}recipes?page=2&limit=1","description":"This is also a getAll recipe endpoint. This endpoint is a protected endpoint which means only logged in user can see all recipe document. The difference betweeen this paginated getAll and thegetALL is that this endpoint has a maximum number of document in a page that can be dynamically set in the query of the url. it takes in page and limit. page is the page number to be accessed and the limit is the number of recipes expected to be on the requested page
\n","urlObject":{"host":["{{URL}}recipes"],"query":[{"key":"page","value":"2"},{"key":"limit","value":"1"}],"variable":[]}},"response":[],"_postman_id":"ead6ce95-4bf4-4904-9474-8601e932b716"},{"name":"getOneRecipe","id":"8fb72542-6362-4202-acce-d362307b96e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{URL}}recipes/61d9a75346eb46eb85e22eb6","description":"This is the getOne recipe endpoint. It gets a particular recipe through its Id. This endpoint is a protected endpoint which means only logged in user can see a recipient that is being filtered by Id. This Api endpoints only returns a recipe which it queried by its Id
\n","urlObject":{"path":["61d9a75346eb46eb85e22eb6"],"host":["{{URL}}recipes"],"query":[],"variable":[]}},"response":[],"_postman_id":"8fb72542-6362-4202-acce-d362307b96e6"},{"name":"delete recipe","id":"d6957f4b-078d-407c-aa7f-a716085d7502","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{URL}}recipes/61de8fe7b5715a052608b7a5","description":"This is the delete recipe endpoint. It deletes a particular recipe through its Id. This endpoint is a protected endpoint which means only logged in user can delete a recipe that is being filtered by Id. This Api endpoints dosent return data
\n","urlObject":{"path":["61de8fe7b5715a052608b7a5"],"host":["{{URL}}recipes"],"query":[],"variable":[]}},"response":[],"_postman_id":"d6957f4b-078d-407c-aa7f-a716085d7502"},{"name":"update recipe","id":"76be3d31-8f79-4856-afbe-cb533836ce59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n\n\"title\" : \"soup stew\"\n\n}\n","options":{"raw":{"language":"json"}}},"url":"{{URL}}recipes/61de912db5715a052608b7aa","description":"This is the update recipe endpoint. It finds a particular recipe through its Id then update the data that are being sent through the post method/form. This endpoint is a protected endpoint which means only logged in user can update a recipe that is being filtered by its Id. This Api endpoints returns the updated data.
\n","urlObject":{"path":["61de912db5715a052608b7aa"],"host":["{{URL}}recipes"],"query":[],"variable":[]}},"response":[],"_postman_id":"76be3d31-8f79-4856-afbe-cb533836ce59"}],"id":"31e0ba19-e419-489e-9ac2-a9bdababa944","description":"The Recipe folder contains five endpoints which includes endpoints to create a recipe, get all recipe, get a single recipe by Id, update a recipe and delete a recipe
\n","_postman_id":"31e0ba19-e419-489e-9ac2-a9bdababa944"}]}