Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backend Routes #4

Open
Mu7ammadAbed opened this issue Jun 8, 2023 · 0 comments
Open

Backend Routes #4

Mu7ammadAbed opened this issue Jun 8, 2023 · 0 comments
Labels
Back-End documentation Improvements or additions to documentation

Comments

@Mu7ammadAbed
Copy link
Contributor

Mu7ammadAbed commented Jun 8, 2023

BackEnd Routes

Auth

Route Method Description Status
api/v1/signup POST sign up into system. 👍
api/v1/login POST log in into system. 👍
api/v1/logout GET log out form the system. 👍

Posts

Route Method Description Status
api/v1/feed GET Get all posts that user following added. ---
api/v1/explore GET Get all posts ordered by date. ---
api/v1/post POST Create new post. ---
api/v1/post/:postId GET Get a specified post. ---
api/v1/post/:postId PUT Update a specified post. ---
api/v1/post/:postId DELETE Delete post that have the specified type. ---
api/v1/post/:type GET Get posts that have a specified type. ---
api/v1/post?q= GET Get posts that have a specified query. ---

Products

Route Method Description Status
api/v1/products GET Get all posts that have category products. 👍

Comments

Route Method Description Status
api/v1/posts/:postId/comments GET Get all comments for specified post. 👍
api/v1/comment/:commentId GET Get a specified comment. 👍
api/v1/comment/:commentId PUT Update a specified comment. 👍
api/v1/comment/:commentId DELETE Delete a specified comment. 👍
api/v1/comment/ POST Add a new comment for the specified post. 👍

Like

Route Method Description Status
api/v1/posts/:postId/like POST Like a specified post. 👍

Follow

Route Method Description Status
api/v1/follow/:userId POST Folow a specified user or unfollow. 👍

Trending

Route Method Description Status
api/v1/trending/products GET Get trending products. 👍
api/v1/trending/users GET Get trending users. 👍

Users

Route Method Description Status
api/v1/users GET Get all users. 👍
api/v1/users/:userId GET Get a specified user. 👍
api/v1/users/:userId PUT Update a specified user. 👍
api/v1/users/:userId/activation POST active or disactive a specified user. 👍

Charts

Route Method Description Status
api/v1/charts GET Get all charts data. 👍

categories

Route Method Description Status
api/v1/categories GET Get all categories. 👍
api/v1/categories POST Add new category. 👍
api/v1/categories/:categoryId GET Get a specified category. 👍
api/v1/categories/:categoryId PUT Update a specified category. 👍
api/v1/categories/:categoryId DELETE Delete a specified category. 👍

messages and notifcations.

These routes are not discussed yet, there are no tables for them untill now.

@Mu7ammadAbed Mu7ammadAbed added documentation Improvements or additions to documentation Back-End labels Jun 8, 2023
@Mu7ammadAbed Mu7ammadAbed pinned this issue Jun 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Back-End documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant