Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bujosa/alzirr
This is my first project related with the Spring Boot ecosystem, I want to achieve with this project, understand what the architecture and structure of this framework is like.
https://github.com/bujosa/alzirr
openapi spring-boot
Last synced: 2 months ago
JSON representation
This is my first project related with the Spring Boot ecosystem, I want to achieve with this project, understand what the architecture and structure of this framework is like.
- Host: GitHub
- URL: https://github.com/bujosa/alzirr
- Owner: bujosa
- License: mit
- Created: 2023-11-09T00:06:42.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-09T01:55:00.000Z (about 1 year ago)
- Last Synced: 2023-11-11T21:28:57.792Z (about 1 year ago)
- Topics: openapi, spring-boot
- Language: Java
- Homepage:
- Size: 69.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# alzirr
This is my first project related with the Spring Boot ecosystem, I want to achieve with this project, understand what the architecture and structure of this framework is like.
## Getting Started
### Prerequisites
- Java 17
- Maven 3.8.2
### Installing
- Clone the repository
- Run the command `mvn clean install` in the root of the project
### Running the application
- Run the command `mvn spring-boot:run` in the root of the project
### Running the application with Docker
- Run the command `docker build -t alzirr .` in the root of the project
- Run the command `docker run -p 8080:8080 alzirr`
### Endpoints
- Swagger UI: http://localhost:8080/swagger-ui.html
- Hello World: http://localhost:8080/ - GET
```bash
curl --location --request GET 'http://localhost:8080/'
```
- Hello World with Your Name: http://localhost:8080 - POST - Body: { "name": "Your Name" }
```bash
curl --location --request POST 'http://localhost:8080/' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Your Name"
}'
```
## Official Documentation
- [Spring Boot](https://spring.io/projects/spring-boot)