Skip to content

Commit 9e031ba

Browse files
AhmetTK4AhmetTK4
authored
Merge pull request #62
Add docs for each web service
2 parents e2136dc + ffadefb commit 9e031ba

10 files changed

+106
-0
lines changed

‎README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ This repository includes various Java projects:
2222
- **[ProxyDesignPattern](https://github.com/AhmetTK4/JavaProjects/tree/main/ProxyDesignPattern)**: Implements the Proxy design pattern in Java.
2323
- **[kullanici-servis](https://github.com/AhmetTK4/JavaProjects/tree/main/kullanici-servis)**: A service application for user management.
2424

25+
## Service Documentation
26+
For details of each web service, see the [docs](docs) folder.
27+
2528
## Installation
2629

2730
1. Clone this repository to your local machine:

‎docs/GameOfLife.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# GameOfLife Service
2+
3+
Spring Boot implementation demonstrating Conway's Game of Life. Provides a REST endpoint to retrieve the next generation grid.
4+
5+
## Endpoints
6+
7+
| Method | Path | Description |
8+
|-------|------------------|--------------------------------------------|
9+
| GET | `/nextGeneration` | Returns the next generation of cells based on provided `rows` and `cols` query parameters. |
10+

‎docs/PlayWithCaches.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# PlayWithCaches Service
2+
3+
Demonstrates caching mechanisms using Spring Boot.
4+
5+
## Endpoints
6+
7+
| Method | Path | Parameters | Description |
8+
|-------|-------|------------|----------------------------|
9+
| GET | `/data` | `param` (query) | Retrieves data, using caching for repeated calls. |
10+

‎docs/PlayWithGenerics.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# PlayWithGenerics Service
2+
3+
Spring Boot project demonstrating usage of generics with REST APIs.
4+
5+
## Endpoints
6+
7+
| Method | Path | Description |
8+
|-------|------|-------------|
9+
| POST | `/api/generic/user` | Add a new `User` to the list. |
10+
| GET | `/api/generic/users` | Retrieve all stored `User` objects. |
11+
| POST | `/api/generic/string` | Add a new `String` value to the list. |
12+
| GET | `/api/generic/strings` | Retrieve all stored strings. |
13+

‎docs/PlayWithJson.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# PlayWithJson Service
2+
3+
Demonstrates handling of JSON files via REST endpoints using Spring Boot.
4+
5+
## Endpoints
6+
7+
| Method | Path | Description |
8+
|-------|------|-------------|
9+
| GET | `/api/data` | Retrieve all entries from `data.json`. |
10+
| POST | `/api/data` | Add a new entry and persist to `data.json`. |
11+
| DELETE | `/api/data/{id}` | Delete an entry by its ID. |
12+

‎docs/PlayWithStreams.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# PlayWithStreams Service
2+
3+
Spring Boot project illustrating stream operations over employee data.
4+
5+
## Endpoints
6+
7+
| Method | Path | Description |
8+
|-------|------|-------------|
9+
| GET | `/employees/high-salary` | List employees with salary greater than 5000. |
10+
| GET | `/employees/names-uppercase` | Return all employee names in uppercase. |
11+
| GET | `/employees/group-by-department` | Group employees by department. |
12+
| GET | `/employees/total-salary` | Calculate total salary of all employees. |
13+

‎docs/PlayWithThreads.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# PlayWithThreads Service
2+
3+
Showcases multithreading techniques with Spring Boot endpoints.
4+
5+
## Endpoints
6+
7+
| Method | Path | Description |
8+
|-------|------|-------------|
9+
| GET | `/start-tasks` | Trigger asynchronous tasks. Accepts `taskCount` query param. |
10+
| POST | `/send-message` | Send a message to Kafka topic. |
11+
| POST | `/scheduler/task1` | Trigger scheduled task 1. |
12+
| POST | `/scheduler/task2` | Trigger scheduled task 2. |
13+
| POST | `/scheduler/notify` | Notify when tasks complete. |
14+
| POST | `/scheduler/send-email` | Send an email with `to`, `subject` and `text` parameters. |
15+
| GET | `/tasks/counts` | Retrieve scheduler task counts. |
16+

‎docs/ProxyDesignPattern.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# ProxyDesignPattern Service
2+
3+
Example project implementing the Proxy design pattern with REST endpoints.
4+
5+
## Endpoints
6+
7+
| Method | Path | Description |
8+
|-------|------|-------------|
9+
| GET | `/api/users/{id}` | Get a user by id. |
10+
| GET | `/api/users/name/{name}` | Find user by username. |
11+
| PUT | `/api/users/{id}/email` | Update user email using `newEmail` parameter. |
12+

‎docs/jacoco-demo.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# jacoco-demo
2+
3+
Spring Boot project demonstrating JaCoCo code coverage. This module does not expose REST endpoints.
4+

‎docs/kullanici-servis.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# kullanici-servis
2+
3+
Quarkus based service for managing users.
4+
5+
## Endpoints
6+
7+
| Method | Path | Description |
8+
|-------|------|-------------|
9+
| GET | `/kullanici` | List all users. |
10+
| POST | `/kullanici` | Create a new user. |
11+
| PUT | `/kullanici/{id}` | Update an existing user. |
12+
| DELETE | `/kullanici/{id}` | Delete a user. |
13+

0 commit comments

Comments
 (0)