Update README

developermithu · developermithu · commit 5d9027208be3 · 2025-03-25T19:40:48.000+06:00
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-## Blog Backend API
+## Laravel - Inertia - React
 
 A Laravel-based RESTful API for managing blog posts and categories. 
 
@@ -68,16 +68,18 @@ php artisan migrate:fresh --seed
 php artisan serve 
 ```
 
-1. Open the application in your web browser at `http://localhost:8000`.
+9. Open the application in your web browser at `http://localhost:8000`.
 
 ## API Documentation
 
 ### Authentication
 
+All authentication endpoints are prefixed with `/api/auth`.
+
 #### Register
 
 ```http
-POST /api/register
+POST /api/auth/register
 ```
 
 | Parameter | Type | Description |
@@ -89,14 +91,24 @@ POST /api/register
 #### Login
 
 ```http
-POST /api/login
+POST /api/auth/login
 ```
 
 | Parameter | Type | Description |
 | :--- | :--- | :--- |
 | `email` | `string` | **Required**. User's email |
 | `password` | `string` | **Required**. User's password |
 
+Successful login returns a **Bearer** token that should be used for authenticated requests.
+
+#### Logout
+
+```http
+POST /api/auth/logout
+```
+
+Requires authentication. Invalidates the current access token.
+
 ### Posts
 
 #### Get All Posts
@@ -105,10 +117,20 @@ POST /api/login
 GET /api/posts
 ```
 
+Supports filtering by:
+
+```http
+GET /api/posts?search=query&status=draft&is_featured=true&filter=trash&page=1&per_page=6
+```
+- search query [search=query]
+- status [status=draft/published]
+- featured posts [is_featured=true/false]
+- trashed posts [filter=all/trash/with_trashed]
+
 #### Get Single Post
 
 ```http
-GET /api/posts/{id}
+GET /api/posts/{slug}
 ```
 
 #### Create Post (Admin Only)
@@ -121,23 +143,45 @@ POST /api/posts
 | :--- | :--- | :--- |
 | `title` | `string` | **Required**. Post title |
 | `slug` | `string` | **Required**. Post slug |
+| `excerpt` | `string` | **Required**. Post excerpt |
 | `content` | `string` | **Required**. Post content |
 | `category_id` | `integer` | **Required**. Category ID |
 | `status` | `string` | **Required**. Post status (draft/published) |
-| `cover image` | `file` | Optional. Post image |
+| `is_featured` | `boolean` | Optional. Featured post status |
+| `cover_image` | `file` | Optional. Post image |
 
 #### Update Post (Admin Only)
 
 ```http
 PUT /api/posts/{slug}
 ```
 
+Accepts the same parameters as the create endpoint.
+
 #### Delete Post (Admin Only)
 
 ```http
 DELETE /api/posts/{slug}
 ```
 
+Soft deletes the post. The post can be restored later.
+
+#### Restore Post (Admin Only)
+
+```http
+POST /api/posts/{id}/restore
+```
+
+Restores a soft-deleted post.
+
+#### Force Delete Post (Admin Only)
+
+```http
+DELETE /api/posts/{id}/force-delete
+```
+
+Permanently deletes the post.
+
 ### Categories
 
 #### Get All Categories
@@ -149,7 +193,7 @@ GET /api/categories
 #### Get Single Category
 
 ```http
-GET /api/categories/{id}
+GET /api/categories/{category}
 ```
 
 #### Create Category (Admin Only)
@@ -166,19 +210,33 @@ POST /api/categories
 #### Update Category (Admin Only)
 
 ```http
-PUT /api/categories/{id}
+PUT /api/categories/{category}
 ```
 
 #### Delete Category (Admin Only)
 
 ```http
-DELETE /api/categories/{id}
+DELETE /api/categories/{category}
 ```
 
 ### Authentication
 
-All admin-only endpoints require authentication using a Bearer token. Include the token in the Authorization header:
+All admin-only endpoints require authentication using a **Bearer** token. Include the token in the Authorization header:
 
 ```http
 Authorization: Bearer <your_token>
-```
+```
+
+### Error Responses
+
+The API uses standard HTTP status codes to indicate the success or failure of requests:
+
+- `200 OK` - Request succeeded
+- `201 Created` - Resource created successfully
+- `400 Bad Request` - Invalid request parameters
+- `401 Unauthorized` - Missing or invalid authentication token
+- `403 Forbidden` - Authenticated but not authorized to access the resource
+- `404 Not Found` - Resource not found
+- `422 Unprocessable Entity` - Validation errors
+
+Made with ❤️ by [developermithu](https://developermithu.com)
