Welcome to the Kotlin Spring Boot RESTful API Playground, a project designed to help you learn how to build RESTful APIs using Kotlin and Spring Boot while applying Clean Architecture principles to ensure your application is well-structured and maintainable.
To run the application, please follow these simple steps:
- Clone the repository to your local machine.
- Open the project in your preferred Integrated Development Environment (IDE), such as IntelliJ IDEA.
- Execute
make allfrom the terminal to start the application. - Once the application is running, it should be available at
http://localhost:8080.
We use Swagger to document our API endpoints. You can access the API documentation by visiting http://localhost:8080/swagger-ui/index.html. Here, you will find a comprehensive list of all available endpoints and their input/output parameters.
Our project follows the Clean Architecture principles, which organizes the code into three main layers:
data: This layer contains the implementation details for accessing and storing data.domain: This layer contains the core domain entities, repositories, and services of your application.web: This layer is used for communication with the outside world.
This project is licensed under the MIT License. For more information, please refer to the LICENSE.md file.
This project was created by argahut@gmail.com. If you have any questions or suggestions, please don't hesitate to reach out.