Skip to content

Latest commit

 

History

History
60 lines (40 loc) · 2.18 KB

README.md

File metadata and controls

60 lines (40 loc) · 2.18 KB
Raw

CourseApiData

Description

This REST API application is a course management tool which allows you to see, edit and delete all courses entries. You can add new courses as well. Each course belongs to a specific topic.

Personal goals

  • To implement a REST API using Spring MVC
  • To build the data layer using Spring Data JPA
  • To understand configuration, deployment and execution of Spring applications

Core technologies

Back-end

  • Spring Boot
  • Hibernate (as a JPA framework)

Database

  • Apache derby

Dependency management tool

  • Maven

IDE

  • Spring Tool Suite

Build setup

  • Clone this repo to your local machine. If you use Spring Tool Suite as IDE, open this project there:
# Import the project to STS

File -> Import -> Git -> Projects from Git -> Existing local repository -> Add ${Directory where you have cloned the repo} -> Import existing Eclipse projects

  • Run the project as Spring Boot App

  • Postman or any other API tester must be already installed in your machine. Otherwise, you will have to install them. You can perform the requests below in order to test the application:

Action HTTP request method Endpoint Body example
Create new topic POST /topics/ {"id": "java", "name": "Java 8", "description": "Java 8 description"}
Read all topics GET /topics/
Read topic GET /topics/java
Update topic PUT /topics/java {"id": "java", "name": "Java 11", "description": "Java 11 description"}
Create new course POST /topics/java/courses {"id": "javaEE", "name": "Java EE", "description": "Java EE description"}
Read all topic courses GET /topics/java/courses
Read course GET /topics/java/courses/javaEE
Update course PUT /topics/java/courses/javaEE {"id": "javaEE", "name": "J2EE", "description": "J2EE description"}
Delete course DELETE /topics/java/courses/javaEE
Delete topic DELETE /topics/java/

References

I have accomplished the aforementioned goals thanks to the following course: