Skip to content

Commit 05b29d0

Browse files
Create README.md
1 parent bc409cc commit 05b29d0

File tree

1 file changed

+115
-0
lines changed

1 file changed

+115
-0
lines changed

README.md

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
# Spring Library
2+
3+
Library REST API developed with Java Spring boot and JWT.
4+
5+
6+
7+
8+
![Java](https://img.shields.io/static/v1?style=for-the-badge&message=Java&color=007396&logo=Java&logoColor=FFFFFF&label=)
9+
10+
![Spring](https://img.shields.io/static/v1?style=for-the-badge&message=Spring&color=6DB33F&logo=Spring&logoColor=FFFFFF&label=)
11+
12+
![Spring Boot](https://img.shields.io/static/v1?style=for-the-badge&message=Spring+Boot&color=6DB33F&logo=Spring+Boot&logoColor=FFFFFF&label=)
13+
14+
![Spring Security](https://img.shields.io/static/v1?style=for-the-badge&message=Spring+Security&color=6DB33F&logo=Spring+Security&logoColor=FFFFFF&label=)
15+
16+
![JSON](https://img.shields.io/static/v1?style=for-the-badge&message=JSON&color=000000&logo=JSON&logoColor=FFFFFF&label=)
17+
18+
## API Reference
19+
20+
#### Get a book
21+
22+
```http
23+
GET /books/${id}
24+
```
25+
26+
| Parameter | Type | Description |
27+
| :-------- | :------- | :------------------------- |
28+
| `Id` | `int` | **Required**. Search a specific book with an Id.
29+
30+
#### Get all books
31+
32+
```http
33+
GET /books/all
34+
```
35+
36+
| Parameter | Type | Description |
37+
| :-------- | :------- | :-------------------------------- |
38+
| `No Parameter` | | **Required**. Search all books |
39+
40+
#### Get books by author
41+
42+
```http
43+
GET /books/author/nameOrSurname
44+
```
45+
46+
| Parameter | Type | Description |
47+
| :-------- | :------- | :-------------------------------- |
48+
| `Name or surname` | `String` | **Required**. Search a book with the author's name or surname (not working right now) |
49+
50+
### Delete a book
51+
```http
52+
Delete /books/delete
53+
```
54+
55+
| Parameter | Type | Description |
56+
| :-------- | :------- | :-------------------------------- |
57+
| `Id` | `int` | **Required**. Deletes a book with the specified Id. |
58+
59+
60+
### Save a book
61+
```http
62+
Post /books/save
63+
```
64+
65+
| Parameter | Type | Description |
66+
| :-------- | :------- | :-------------------------------- |
67+
| `Book` | `book` | **Required**. Saves a book with the information required. |
68+
69+
70+
71+
#### Get all borrows
72+
73+
```http
74+
GET /borrows/all
75+
```
76+
77+
| Parameter | Type | Description |
78+
| :-------- | :------- | :------------------------- |
79+
| `No parameter` | | **Required**. Gets all the borrows registered.
80+
81+
### Gets a specific borrow
82+
```http
83+
Get /borrows/book/{bookId}
84+
```
85+
86+
| Parameter | Type | Description |
87+
| :-------- | :------- | :-------------------------------- |
88+
| `Id` | `int` | **Required**. Search a specifics borrow with a book ID |
89+
90+
### Gets a specific borrow
91+
```http
92+
Get /borrows/student/{studentId}
93+
```
94+
95+
| Parameter | Type | Description |
96+
| :-------- | :------- | :-------------------------------- |
97+
| `Id` | `int` | **Required**. Search a specifics borrow with a student ID |
98+
99+
### Saves a borrow
100+
```http
101+
Post /borrows/save
102+
```
103+
104+
| Parameter | Type | Description |
105+
| :-------- | :------- | :-------------------------------- |
106+
| `Borrow` | `borrow` | **Required**. Saves a borrow with the information required.|
107+
108+
## Authors
109+
110+
- [@BrunoMazzocchi](https://www.github.com/BrunoMazzocchi)
111+
112+
113+
## 🚀 About Me
114+
I'm a student looking for opportunities as a backend developer.
115+

0 commit comments

Comments
 (0)