Course Management API is a REST API which manages different courses with CRUD ability using MySQL database. The Course resources are organized under Topic resources. This API is built with Spring Boot 2.4.0., using Spring Initializr. This project starts off from the Spring Boot Quick Start Course by JavaBrains on Youtube, and adds support for persistent data thanks to MySQL.
Before you begin, ensure you have met the following requirements:
- Java 8 JDK: https://www.oracle.com/java/technologies/javase/javase-jdk8-downloads.html
- MySQL version 5.6 or later (you can obtain the MySQL Community Server from here. See this guide from Spring on how to set up MySQL for this project; start from the "Create the Database" section.)
- All Spring Boot dependencies are included in this project's pom.xml.
- Spring Web
- Spring Data JPA
- MySQL Driver
- Postman (to construct API requests and view responses): https://www.postman.com/downloads/
To install Course Management API, follow these steps to clone this repo on your system:
git clone https://github.com/dawungayi/course-management-api.git
To use Course Management API, follow these steps:
- Open terminal in Mac OSX / Linux or command prompt in Windows. In the root directory of this project, start the API on port 8080 by running:
Coming soon
- Coming soon
- Coming soon
If using a Chrome, it is recommended to install a JSON parser browser extension for better readibility of the output JSON data, like this one: JSONView.
Thanks to the following people who have contributed to this project:
If you want to contact me you can reach me at [email protected].
This project uses the following license: MIT.