/beer-api

Simple rest api providing beer info.

Primary LanguageJavaMIT LicenseMIT

Beer Api

Contributors Forks Stargazers Issues MIT License

Table of contents

About The Project

Api providing beers, beer styles and beer producers informations.

Technologies

  • Java 17
  • SpringBoot 2.7.0
  • Maven
  • H2 Database
  • MySQL
  • Liquibase
  • Lombok
  • Swagger
  • Git

Getting started

To setup and run this project:

  1. Clone repository git clone https://github.com/matsior/beer-api.git
  2. Build project with maven mvn spring-boot:run
  3. After running application Swagger documentation available at: http://localhost:8080/api/swagger-ui/index.html

Exploring Beer Api

Available endpoints and CRUD operations (click to see details):

Beer:
Method Url Description Sample Valid Request Body
GET /api/beers Get all beers
GET /api/beers/{id} Get single beer by Id
Beer Producers: ...
Beer Styles: ...
Users: ...

Roadmap

  • Implement core functionalities
  • Expand database model (add User entity)
  • Create documentation
  • Add cache
  • Add Spring Security
  • Write unit tests
  • Write integration tests
  • Deploy application on Heroku

Contributing

Coming soon...

License

Distributed under the Mit License. Check here for more information.