Skip to content

Commit b838cc5

Browse files
committed
update README.md
1 parent bf3974c commit b838cc5

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,25 @@
11
# Spring-Boot-REST-API-Example-Volleyballteam
22
This application will explore how to create REST APIs for CRUD operations using Spring Boot framework.
3+
4+
To start the application, run the following command in your terminal:
5+
```
6+
mvn spring-boot:run
7+
```
8+
9+
## How to use the application
10+
11+
With the application running, open your browser and navigate to http://localhost:8080/swagger-ui/index.html.
12+
You will see the Swagger UI page from where you can test the REST APIs.
13+
14+
Of course, you can also use Postman or any other REST client to test the APIs.
15+
The REST API can be accessed at http://localhost:8080/api/teams.
16+
17+
Following endpoints are available in the application:
18+
- GET /api/teams - Get all teams
19+
- GET /api/teams/{name} - Get team by name
20+
- GET /api/teams/players - Get all players
21+
- GET /api/teams/players/{id} - Get player by id
22+
- GET /api/teams/{name}/players - Get all players by team name
23+
- POST /api/teams/team-management - Create or update a team
24+
- POST /api/teams/team-management/players - Add a player to a team
25+
- DELETE /api/teams/team-management/players - Remove a player from a team

0 commit comments

Comments
 (0)