Skip to content

muhkelvin/Rest_api-Blog

Repository files navigation

Blog REST API

About The Project

Blog REST API is a Laravel-based application that provides API endpoints for Blog management. This project includes Swagger documentation to make API exploration and testing easier.

Live Documentation

The API documentation is available at: [https://rest-blog.netlify.app/)

Installation

Follow these steps to set up the project locally:

  1. Clone the repository
git clone [repository-url]
  1. Install PHP dependencies
composer install
  1. Create environment file
cp .env.example .env
  1. Generate application key
php artisan key:generate
  1. Configure your database in the .env file
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=your_database
DB_USERNAME=your_username
DB_PASSWORD=your_password
  1. Run database migrations
php artisan migrate
  1. Start the development server
php artisan serve

The application will be available at http://localhost:8000.

API Documentation

This project uses Swagger for API documentation. To access the API documentation:

  1. Run the development server
php artisan serve
  1. Visit http://localhost:8000/api/documentation in your browser

Alternatively, you can view the deployed documentation at [https://rest-blog.netlify.app/)

Features

  • RESTful API endpoints for blog management
  • Swagger documentation for API exploration
  • Laravel-based architecture for robust application development

Technologies Used

About Laravel

Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:

License

This project is open-sourced software licensed under the MIT license.

About

One To Many

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published