Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/krisnaajiep/slim-blogging-platform-api
A simple RESTful API with basic CRUD operations for a personal blogging platform.
https://github.com/krisnaajiep/slim-blogging-platform-api
api blog blogging blogging-platform create-read-update-delete crud crud-api crud-operation mysql mysql-database php php8 rest-api restapi restful restful-api slim slim-framework slim4 slimphp
Last synced: 2 days ago
JSON representation
A simple RESTful API with basic CRUD operations for a personal blogging platform.
- Host: GitHub
- URL: https://github.com/krisnaajiep/slim-blogging-platform-api
- Owner: krisnaajiep
- Created: 2025-01-09T09:21:21.000Z (7 days ago)
- Default Branch: main
- Last Pushed: 2025-01-12T16:40:14.000Z (3 days ago)
- Last Synced: 2025-01-12T17:33:46.032Z (3 days ago)
- Topics: api, blog, blogging, blogging-platform, create-read-update-delete, crud, crud-api, crud-operation, mysql, mysql-database, php, php8, rest-api, restapi, restful, restful-api, slim, slim-framework, slim4, slimphp
- Language: PHP
- Homepage:
- Size: 26.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Slim Bloggin Platform API
> Simple Blogging Platform RESTful API built with Slim framework.
## Table of Contents
- [General Info](#general-information)
- [Technologies Used](#technologies-used)
- [Features](#features)
- [Setup](#setup)
- [Usage](#usage)
- [HTTP Response Code](#http-response-code)
- [Project Status](#project-status)
- [Acknowledgements](#acknowledgements)
## General Information
Slim Blogging Platform API is a simple RESTful API that provide basic CRUD operations for a personal blogging platform. CRUD stands for Create, Read, Update, and Delete. This project is designed to explore and practice working with the CRUD Operation, RESTful API and database in PHP.
## Technologies Used
- PHP - version 8.3.6
- MySQL - version 8.0.4
- [Slim](https://www.slimframework.com/) 4
## Features
List the ready features here:
- **Create Blog Post**: Create a new blog post using the `POST` method.
- **Get Blog Post**: Get a single blog post using the `GET` method.
- **Get All Blog Posts**: Get all blog posts using the `GET` method.
- **Filter Blog Post**: Filter blog posts by a search term.
- **Update Blog Post**: Update an existing blog post using the `PUT` method.
- **Delete Blog Post**: Delete an existing blog post using the `DELETE` method.
## Setup
To run this CLI tool, you’ll need:
- **PHP**: Version 8.3 or newer
- **MySQL**: Version 8.0 or newer
- **Composer**: Version 2.7 or newer
How to install:
1. Clone the repository
```bash
git clone https://github.com/krisnaajiep/slim-blogging-platform-api.git
```
2. Change the current working directory
```bash
cd slim-blogging-platform-api/public
```
3. Install dependecies
```bash
composer install
```
4. Configure `.env` file for database configuration.
```bash
cp .env.example .env
```
```dotenv
# DATABASE CONFIG
DB_HOST=localhost
DB_PORT=3306
DB_USER=root
DB_PASS=
DB_NAME=blog
```
5. [Start MySQL server](https://phoenixnap.com/kb/start-mysql-server)
6. Run the PHP built-in Web Server
```bash
php -S localhost:8888
```
## Usage
Example API Endpoints:
1. **Create a Blog Post**
- Method: `POST`
- Endpoint: `/posts`
- Request Body:
- `title` (string) - The title of the post.
- `content` (string) - The content of the post.
- `category` (string) - The category of the post.
- `tags` (array) - An array of tags associated with the post.
- Example Request:
```http
POST /posts
{
"title": "My First Blog Post",
"content": "This is the content of my first blog post.",
"category": "Technology",
"tags": ["Tech", "Programming"]
}
```
- Response:
- Status: `201 Created`
- Content-Type: `application/json`
- Example Response:
```json
{
"id": 1,
"title": "My First Blog Post",
"content": "This is the content of my first blog post.",
"category": "Technology",
"tags": ["Tech", "Programming"],
"createdAt": "2021-09-01T12:00:00Z",
"updatedAt": "2021-09-01T12:00:00Z"
}
```
2. **Get a Single Post**
- Method: `GET`
- Endpoint: `/posts/{id}`
- Response:
- Status: `200 OK`
- Content-Type: `application/json`
- Example Response:
```json
{
"id": 1,
"title": "My First Blog Post",
"content": "This is the content of my first blog post.",
"category": "Technology",
"tags": ["Tech", "Programming"],
"createdAt": "2021-09-01T12:00:00Z",
"updatedAt": "2021-09-01T12:00:00Z"
}
```
3. **Get All Blog Posts**
- Method: `GET`
- Endpoint: `/posts`
- Response:
- Status: `200 OK`
- Content-Type: `application/json`
- Example Response:
```json
[
{
"id": "1",
"title": "My Updated Blog Post",
"content": "This is the updated content of my first blog post.",
"category": "Technology",
"tags": ["Tech", "Programming"],
"created_at": "2025-01-12T17:42:27Z",
"updated_at": "2025-01-12T17:44:52Z"
},
{
"id": "2",
"title": "My Second Blog Post",
"content": "This is the content of my second blog post.",
"category": "Nature",
"tags": ["Nature", "Wildlife"],
"created_at": "2025-01-12T17:42:58Z",
"updated_at": "2025-01-12T17:42:58Z"
},
{
"id": "3",
"title": "My Third Blog Post",
"content": "This is the content of my third blog post.",
"category": "Urban",
"tags": ["Urban", "City", "Architecture"],
"created_at": "2025-01-12T17:43:44Z",
"updated_at": "2025-01-12T17:43:44Z"
},
{
"id": "4",
"title": "My Fourth Blog Post",
"content": "This is the content of my fourth blog post.",
"category": "Nature",
"tags": ["Nature", "Mountain", "Hiking"],
"created_at": "2025-01-12T17:44:28Z",
"updated_at": "2025-01-12T17:44:28Z"
}
]
```
- Params:
- `term` - Search keyword for post by title, content, category or tags.
4. **Update an Existing Blog Post**
- Method: `PUT`
- Endpoint: `/posts/{id}`
- Request Body:
- `title` (string) - The title of the post.
- `content` (string) - The content of the post.
- `category` (string) - The category of the post.
- `tags` (array) - An array of tags associated with the post.
- Example Request:
```http
PUT /posts/1
{
"title": "My Updated Blog Post",
"content": "This is the updated content of my first blog post.",
"category": "Technology",
"tags": ["Tech", "Programming"]
}
```
- Response:
- Status: `200 OK`
- Content-Type: `application/json`
- Example Response:
```json
{
"id": 1,
"title": "My Updated Blog Post",
"content": "This is the updated content of my first blog post.",
"category": "Technology",
"tags": ["Tech", "Programming"],
"createdAt": "2021-09-01T12:00:00Z",
"updatedAt": "2021-09-01T12:30:00Z"
}
```
5. **Delete an Existing Blog Post**
- Method: `DELETE`
- Endpoint: `/posts/{id}`
- Response:
- Status: `204 No Content`
- Content-Type: `text/xml`
## HTTP Response Code
The following status codes are returned by the API depending on the success or failure of the request.
| Status Code | Description |
| ------------------------- | --------------------------------------------------------- |
| 200 OK | The request was processed successfully. |
| 201 Created | The new resource was created successfully. |
| 400 Bad Request | The server cannot process a request due to a client error |
| 404 Not Found | The requested resource was not found. |
| 500 Internal Server Error | An unexpected server error occurred. |
## Project Status
Project is: _complete_.
## Acknowledgements
This project was inspired by [roadmap.sh](https://roadmap.sh/projects/blogging-platform-api).