https://github.com/grootkng/star-wars-api
An Star Wars API with Spring implementing Clean Architecture
https://github.com/grootkng/star-wars-api
clean-architecture java spring spring-boot
Last synced: about 2 months ago
JSON representation
An Star Wars API with Spring implementing Clean Architecture
- Host: GitHub
- URL: https://github.com/grootkng/star-wars-api
- Owner: grootkng
- Created: 2023-05-18T23:49:28.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-20T20:23:59.000Z (about 3 years ago)
- Last Synced: 2024-04-23T11:19:42.913Z (about 2 years ago)
- Topics: clean-architecture, java, spring, spring-boot
- Language: Java
- Homepage:
- Size: 85.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Star Wars API
A Star Wars Planet API
Requisites:
- An REST API
- For each planet, these data need to be retrieved from the database:
- name
- weather
- terrain
- Number of times that a planet appeared in the movies, from the public Star Wars API (https://swapi.co/)
Desirable functionalities:
- [x] Add a planet (name, weather and terrain)
- [X] List planets (with pagination)
- [X] Search by name
- [X] Search by ID
- [X] Remove a planet
- [X] Update a planet
## Docs
URLs
- Swagger: http://localhost:8080/swagger-ui/index.html#/
- Planet: http://localhost:8080/v1/planet
Insomnia collections on docs/insomnia_collection
### How to run the project
Just need to run:
```shell
docker-compose up -d
```
And the application will start already connected with the database
### Technologies
- Java 17
- Spring
- Postgres
- Docker
- Swagger
- JUnit