This is a simple example API built using Spring Boot and WebFlux, demonstrating the concept of reactive programming. The API provides endpoints for fetching data asynchronously using the reactive programming model.
Before running the API, make sure you have the following prerequisites installed:
- Java Development Kit (JDK) 8 or higher
- Maven or Gradle (depending on your preference)
To get started with the API, follow these steps:
-
Clone the repository to your local machine:
git clone <repository-url>
-
Navigate to the project directory:
cd reactive-programming-example-api
-
Build the project using Maven or Gradle:
For Maven:
mvn clean install
For Gradle:
gradle clean build
-
Run the API:
For Maven:
mvn spring-boot:run
For Gradle:
gradle bootRun
-
Once the API is running, you can access the endpoints using the base URL
http://localhost:8080
.
The API provides the following endpoints:
- Endpoint:
/api/v1/students
- Method: GET
- Description: Fetches the data from a reactive data source.
- Example Request:
GET /data HTTP/1.1 Host: localhost:8080
- Example Response:
{ "id": 1, "firstname": "Tamerlan", "lastname":"Mustafayev", "age":29 }
Contributions to this project are welcome. If you encounter any issues or have suggestions for improvements, please open an issue or submit a pull request.
This project is licensed under the MIT License.
This API is inspired by the concept of reactive programming and uses the Spring Boot and WebFlux frameworks. Special thanks to the open-source community for their contributions to these frameworks.