Skip to content

Latest commit

 

History

History
205 lines (106 loc) · 9.11 KB

README.md

File metadata and controls

205 lines (106 loc) · 9.11 KB
Raw

Plain PHP REST/RESTful API with Token-based Authentication and Image Uploading

A Comprehensive Plain PHP & MySQL REST/RESTful API with Token-based Authentication and Image Uploading feature. The API is built following the MVC (Model-View-Controller) Design Pattern, and is totally Object-oriented (OOP).

The idea is an API for creating personal To-Do Lists (Tasks) and their associated Images. You can create a To-Do List and assign an image to each task.

This project script is entirely written in plain PHP (OOP) and aims to showcase the implementation of an API with Token-based Authentication without relying on any external libraries or frameworks.

Screenshots:

REST/RESTful API Constraints:

REST-API-Constraints

Features:

1- MVC Design Pattern.

2- Advanced use of the .htaccess "per-directory" Apache configuration file for routing control and URL redirection (URL Rewriting using the RewriteEngine). Check the API's .htaccess file.

3- Token-based Authentication using a short-lived "Access Token" (20 minutes) and a longer-term "Refresh Token" (2 weeks).

4- Totally Object-oriented design.

5- Protected Routes.

6- HTTP Responses with Pagination.

7- Advanced Error Handling involving custom Exception classes which return appropriate JSON format error messages with the right HTTP Status Codes.

8- Advanced SQL INNER JOIN clauses and CRUD operations.

9- File Upload and File Download API Endpoints.

10- Registration, Validation, Authentication, and Authorization.

API Endpoints:

** Check the API Collection on my Postman Profile: https://www.postman.com/ahmed-yahya/workspace/my-public-portfolio-postman-workspace/collection/28181483-41805882-779b-42f7-a246-e96e32633ff5

** Also, you can test the API Endpoints using Postman. Here is the API's Postman Collection .json file Postman Collection file you can download and import in your Postman.

1- Register/Sign up/Create a new user (POST):

POST /v1/users

  • "Content-Type" HTTP Request Header must be set to "application/".

  • Mandatory fields in the JSON HTTP Request Body: fullname, username, and password.

2- Log in and Create a new session with a new Access Token and a new Refresh Token (POST):

POST /v1/sessions

  • "Content-Type" HTTP Request Header must be set to "application/json".

  • Mandatory fields in the JSON HTTP Request Body: username and password.

3- Log out and delete a session (DELETE):

DELETE /v1/sessions/{sessionid}

  • {sessionid} Query String Parameter in the URL must be provided.

  • "Authorization" HTTP Request Header (Access Token) must be provided.

4- Refresh a session (update a session to get a new Access Token and a new Refresh Token instead of the expired Access Token) (PATCH):

PATCH /v1/sessions/{sessionid}

  • {sessionid} Query String Parameter in the URL must be provided.

  • "Content-Type" HTTP Request Header must be set to "application/json".

  • "Refresh Token" must be provided as JSON in the HTTP Request Body (Not as an 'Authorization' HTTP Request Header).

  • "Access Token" must be provided as an "Authorization" HTTP Request Header.

5- Create a new task (POST):

POST /v1/tasks

  • "Authorization" HTTP Request Header (Access Token) must be provided.

  • "Content-Type" HTTP Request Header must be set to "application/json".

  • Mandatory fields in the JSON HTTP Request Body: title and completed.

6- Get ALL tasks that belong to the authenticated/logged-in user (GET):

GET /v1/tasks

  • "Authorization" HTTP Request Header (Access Token) must be provided.

7- Get a Single task (GET):

GET /v1/tasks/{taskid}

  • {taskid} Query String Parameter in the URL must be provided.

  • "Authorization" HTTP Request Header (Access Token) must be provided.

8- Delete a single task (DELETE) (that belongs to the authenticated/logged-in user): (this also deletes all of the associated images as well as the task images folder inside the 'taskimages' folder)

DELETE /v1/tasks/{taskid}

  • {taskid} Query String Parameter in the URL must be provided.

  • "Authorization" HTTP Request Header (Access Token) must be provided.

9- Update a single task (PATCH):

PATCH /v1/tasks/{taskid}

  • {taskid} Query String Parameter in the URL must be provided.

  • "Authorization" HTTP Request Header (Access Token) must be provided.

  • "Content-Type" HTTP Request Header must be set to "application/json".

  • Mandatory fields in the JSON HTTP Request Body: At least one of the fields: title, description, deadline, and completed.

10- Get all 'Complete' tasks (GET):

GET /v1/tasks/complete

  • {complete} or {incomplete} Query String Parameter in the URL must be provided.

  • "Authorization" HTTP Request Header (Access Token) must be provided.

11 - Get all 'Incomplete' tasks (GET):

GET /v1/tasks/incomplete

  • {complete} or {incomplete} Query String Parameter in the URL must be provided.

  • "Authorization" HTTP Request Header (Access Token) must be provided.

12- Get All tasks with Pagination (tasks that belong to the authenticated/logged-in user) (GET):

GET /v1/tasks/page/{pagenumber}

  • {page} Query String Parameter and its value {pagenumber} in the URL must be provided.

  • "Authorization" HTTP Request Header (Access Token) must be provided.

13- Create (Upload) an image for a certain task (of the authenticated/logged-in user):

POST /tasks/{taskid}/images

  • {taskid} Query String Parameter in the URL must be provided.

  • "Authorization" HTTP Request Header (Access Token) must be provided.

  • "multipart/form-data; boundary=" HTTP Request Header must be provided.

  • In Postman, click on "Body", then "form-data", then enter two fields: "attributes" and "imagefile" fields. For the "attributes" field, set it to "Text" and enter the Value as JSON (Example: {"title": "Image Title 1", "filename": "carimage"}) and don't mention the file extension in the file name. For the"imagefile" field, set it to "File", and upload an image file in the Value. Only .jgp, .gif, or .png images are allowed.

14- Get (Download) an actual physical image of a certain task (of the authenticated/logged-in user):

GET /tasks/{taskid}/images/{imageid}

  • {taskid} and {imageid} Query String Parameters in the URL must be provided.

  • "Authorization" HTTP Request Header (Access Token) must be provided.

15- Delete an actual physical image of a certain task (of the authenticated/logged-in user):

DELETE /tasks/{taskid}/images/{imageid}

  • {taskid} and {imageid} Query String Parameters in the URL must be provided.

  • "Authorization" HTTP Request Header (Access Token) must be provided.

16- Get a certain image Attributes (of a certain task that belongs to the authenticated/logged-in user):

GET /tasks/{taskid}/images/{imageid}/attributes

  • The three of {taskid}, {imageid} and {attributes} Query String Parameters in the URL must be provided.

  • "Authorization" HTTP Request Header (Access Token) must be provided.

17- Update a certain image Attributes (of a certain task that belongs to the authenticated/logged-in user):

PATCH /tasks/{taskid}/images/{imageid}/attributes

  • The three of {taskid}, {imageid} and {attributes} Query String Parameters in the URL must be provided.

  • "Authorization" HTTP Request Header (Access Token) must be provided.

  • "Content-Type" HTTP Request Header must be set to "application/json".

  • Mandatory fields in the JSON HTTP Request Body: At least one of the two fields: title and filename. N.B. File Name must be provided WITHOUT the file extension.

Installation & Configuration:

1- Clone the project or download it.

2- Create a MySQL database named `tasksdb` and import the database SQL Dump file tasksdb Database SQL Dump File.

3- Navigate to the Database Connection Class file db.php and configure/edit/update it with your MySQL database credentials and other configuration settings.

4- Important Note: "Apache" Web Server must be used for serving this API in order for the .htaccess file to work, as I based all of the routing system work and URL redirection/URL Rewriting on the .htaccess file (RewriteEngine and RewriteRule-s). Check the API's .htaccess file. Start by typing in the API Endpoint: POST http://127.0.0.1/v1/users in your Postman to Sign up.

  • Credentials of a ready-to-use registered user account are: (Use this account to Log in and create a new session i.e. get a new "Access Token" and "Refresh Token" with the following Endpoint: POST http://127.0.0.1/v1/sessions)

Username: Ahmed, Password: 123456

Contribution:

Contributions to my plain PHP REST/RESTful API are most welcome! If you find any issues or have suggestions for improvements, want to add new features or want to contribute code or documentation, please open an issue or submit a pull request.