|
1 | | -# RandomBook |
| 1 | +Spring Boot REST API example |
| 2 | +===== |
2 | 3 |
|
3 | | -This is a simple coding exercise which implements a REST API built using Spring Boot and JDBC. I created this project to learn some features of Spring Boot. |
| 4 | +This repository is an example application for the Spring Boot framework. |
| 5 | +The example is a standalone REST API server in Java. |
4 | 6 |
|
5 | | -The purpose of the web app will be to promote reading by proposing to read a random book of a given category. Each book can be rated and the readings made are tracked. |
| 7 | +This repository shows the following features: |
| 8 | +* Controllers |
| 9 | +* JDBC |
6 | 10 |
|
7 | | -## Getting Started |
8 | 11 |
|
9 | | -Clone the repo with git clone, as usual. |
| 12 | +Random Book |
| 13 | +---- |
10 | 14 |
|
11 | | -## Running the tests |
| 15 | +Random Book wants to promote reading by proposing to read a random book of a given category. |
| 16 | +Each book can be rated and the readings made are tracked. |
12 | 17 |
|
13 | | -Test file: src/test/java/com.example.randombook/RandombookApplicationTests.java |
14 | 18 |
|
15 | | -It contains basic test operations. |
16 | | - |
17 | | -## API Documentation |
| 19 | +API Documentation |
| 20 | +---- |
18 | 21 |
|
19 | 22 | To view the API Documentation, run the code and navigate to http://localhost:8080/swagger-ui.html |
20 | 23 |
|
|
0 commit comments