/Blog-API-Laravel

Primary LanguagePHP

Blog-API-Laravel

Table of Contents

1. Design

   1.1. Database Design

   1.2. API Endpoints

1. Project Design

1.1. DataBase Design

A Rough View of the Databases

databases

Users

  • user id (auto-increment)
  • email (unique)
  • phone
  • password

User Profiles

  • user id (foreign key referencing Users(user_id) )
  • first name
  • last name
  • role [editor, writer]

Articles

  • article id (auto-increment)
  • title
  • post
  • creator id ( foreign key referencing Users (user_id) )

Comments

  • comment id (auto-increment)
  • article id (foreign key referencing Articles (article_id) )
  • creator id (foreign key referencing Users (user_id) )
  • content

Assumptions

  • By default a user is a writer.

  • User can edit their profile to become an editor

  • A Writer can

    • make an article
    • add comments to the articles
    • view only their articles
    • view only their comments on their articles

  • An editor can

    • view all articles
    • add comment to articles
    • view only the comments made by them

1.2. API Endpoints

User Registration

  • Method: POST
  • End Point: /register
  • Request Body: { "email", "phone", "password", "password_confirmation" }
  • Action: Register a new user with the provided credentials.

User Login

  • Method: POST
  • Endpoint: /login
  • Request Body: { "email", "password" }
  • Action: Authenticate the user.

User Logout

  • Method: POST
  • Endpoint: /logout
  • Action: Invalidate the user.

Update User Profile

  • Method: PUT
  • Endpoint: /profile
  • Request Body: { "first name", "last name", "role" }
  • Action:
    • Edit the user's profile information.
    • Default: First and Last name are null and Role is set to "writer".

View User Profile

  • Method: GET
  • Endpoint: /profile
  • Action: Retrieve the user's profile information.

Create Article

  • Method: POST
  • Endpoint: /articles
  • Request Body: { "title", "post" }
  • Action: Allow a user with the "writer" role to create a new article.

Check Article Access

  • Method: GET
  • Endpoint: /articles
  • Action:
    • Show IDs of the articles the user has acess to.
    • If "writer": only their own articles will be shown
    • If "editer": all articles will be shown

Read Article

  • Method: GET
  • Endpoint: /articles/{article_id}
  • Action: Retrieve details of a specific article.

Update Article

  • Method: PUT
  • Endpoint: /articles/{article_id}
  • Request Body: { "title", "post" }
  • Action: Allow a user with the "writer" role to update an article they created.

Delete Article

  • Method: DELETE
  • Endpoint: /articles/{article_id}
  • Action: Allow a user with the "writer" role to delete an article they created.

Create Comment

  • Method: POST
  • Endpoint: /articles/{article_id}/comments
  • Request Body: { "content" }
  • Action: Allow a user with the "editor" role to create a comment on an article.

Read Comments

  • Method: GET
  • Endpoint: /articles/{article_id}/comments
  • Action: Allow a user with the "writer" role to read comments on an article they created.

Delete Comment

  • Method: DELETE
  • Endpoint: /articles/{article_id}/comments{comment_id}
  • Action: Allow a user to delete a comment that they created.