Post Here helps you find the best place to share on Reddit. The user enters their post and Post Here finds the subreddit that is most appropriate for that post.
\nMVP
\nWEB:
\nDS:
\nSTRETCH
\nDS
\nWeb
\nWEB UI DEVELOPER
\nWEB REACT I
\nWEB REACT II
\nBACKEND DEVELOPER
\nDATA ENGINEER
\nMACHINE LEARNING ENGINEERS
\n[POST] /api/auth/login - 200 OK\n{\n \"username\": \"admin\",\n \"password\": \"admin\"\n}
\nResponse returns object with id, token, redditAuth and redditState keys.\nThe redditAuth is a boolean that determines if the user is logged in with reddit or not. If not, front-end needs to request the api/reddit/auth and refresh the token. The redditState is the token required to be in the request body when requesting the reddit access token in /api/reddit/auth -> state.
[POST] /api/auth/login - 401 Bad Request\n{\n \"username\": \"admin\"\n}
\nResponse returns error object with all the information about the error. The most important key is the message.
[POST] /api/auth/login - 403 Forbidden\n{\n \"username\": \"admin\",\n \"password\": \"admin1\"\n}
\nResponse returns error object with all the information about the error. The most important key is the message.
[POST] /api/auth/login - 404\n{\n \"username\": \"admin1\",\n \"password\": \"admin\"\n}
\nResponse returns error object with all the information about the error. The most important key is the message.
[POST] /api/auth/register - 201 OK\n{\n \"username\": \"test\",\n \"password\": \"test\"\n}
\nResponse returns new user object with id and username keys.
[POST] /api/auth/register - 401 Bad Request\n{\n \"username\": \"test\"\n}
\nResponse returns error object with all the information about the error. The most important key is the message.
[GET] /api/reddit - 200 OK
\nNeeds Authorization header with the logged in user token
\nOptional query param: mobile (boolean: 0 or 1)
\nResponse is an object with url key holding the url the user should be redirected to.
[GET] /api/reddit/auth - 200 OK
\nNeeds Authorization header with the logged in user token
\nRequired parameters after user allows/rejects access to reddit:\nstate=HASHED_STATE;\ncode=REDDIT_CODE;
\nResponse is an object with authorized key with boolean value.\nThis endpoint is used to get a reddit access_token or refresh the token.
[GET] /api/posts - 200 OK
\nNeeds Authorization header with the logged in user token
\nResponse is an array with post objects of the currently logged in user.
\n","urlObject":{"protocol":"http","port":"4000","path":["api","posts"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"145eb657-81e7-490f-9dba-51477a08342f"},{"name":"Posts - Single - Success","id":"e808ece9-24c0-4f34-899a-e6ed2eedc662","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWJqZWN0IjoxLCJ1c2VybmFtZSI6ImFkbWluIiwiaWF0IjoxNTc0MjU2NDA2LCJleHAiOjE1NzQyODUyMDZ9.qqt5Radv6_F2vsjYRH3GP8YQYRkXmLT7C7eAv9Oqt1I"}],"url":"http://localhost:4000/api/posts/3","description":"[GET] /api/posts/:id - 200 OK
\nNeeds Authorization header with the logged in user token
\n:id needs to be a positive integer id of existent post
\nResponse is a single post object of the currently logged in user.
\n","urlObject":{"protocol":"http","port":"4000","path":["api","posts","3"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"e808ece9-24c0-4f34-899a-e6ed2eedc662"},{"name":"Posts - Create - Success","id":"ebf8520d-a0e7-49f4-85d1-4ef8620588e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWJqZWN0IjoxLCJ1c2VybmFtZSI6ImFkbWluIiwiaWF0IjoxNTc0MzMwODY5LCJleHAiOjE1NzQzNTk2Njl9.mCWlnmbeH9uSHKb1fd3rwmA93WPvFpExaAjcaHdtk90"}],"body":{"mode":"raw","raw":"{\n\t\"title\": \"A title here\",\n\t\"text\": \"A text here\"\n}"},"url":"http://localhost:4000/api/posts/","description":"[POST] /api/posts - 201 Created
\nNeeds Authorization header with the logged in user token
\nResponse returns the post data and a suggestions array with the suggested subreddits for the post.
[POST] /api/posts/reddit - 200 OK
\nNeeds Authorization header with the logged in user token
\nCreates a post in the chosen subreddit - REAL REDDIT.
\nRequires title, text, subreddit and state.
[PUT] /api/posts/:id - 200 OK
\nNeeds Authorization header with the logged in user token
\n:id needs to be a positive integer id of existent post
\n","urlObject":{"protocol":"http","port":"4000","path":["api","posts","1"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"805f37ba-7c19-4ffb-8339-f3840c12dcf2"},{"name":"Posts - Remove - Success","id":"463945ea-6396-4f96-a757-78e9524a5f17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWJqZWN0IjoxLCJ1c2VybmFtZSI6ImFkbWluIiwiaWF0IjoxNTc0MDk1Mzc3LCJleHAiOjE1NzQxMjQxNzd9.7nAI3KjCdL7Zq0cwE6UhSQIoJohDPvzLo8uhBif3cIY"}],"url":"http://localhost:4000/api/posts/1","description":"[DELETE] /api/posts/:id - 200 OK
\nNeeds Authorization header with the logged in user token
\n:id needs to be a positive integer id of existent post
\n","urlObject":{"protocol":"http","port":"4000","path":["api","posts","1"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"463945ea-6396-4f96-a757-78e9524a5f17"}],"event":[{"listen":"prerequest","script":{"id":"02f6992a-adc5-4bcc-bc45-83183add5cdc","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e94f425e-adf8-4a5f-a805-578299e80458","type":"text/javascript","exec":[""]}}]}