Skip to content

Repository files navigation

Ahoi Kapptn Burger API

Technical Stack

  • Language: Kotlin
  • Framework: Spring Boot 3.2.4
  • Database: MongoDB
  • Documentation: OpenAPI 3 / Swagger UI
  • Containerization: Docker
  • Testing: JUnit 5 with MockMvc

Features

  • Menu Management: Full retrieval of burger and drink categories.
  • Search: Query items by name using case-insensitive partial matching.
  • Price Filtering: Filter menu items based on a specified price range (min/max).
  • Documentation: Auto-generated interactive API documentation via Swagger.
  • Database Integration: Persistence layer handled by Spring Data MongoDB.
  • Testing: Integration tests implemented to verify endpoint availability and JSON response formats.

API Endpoints

Burgers

  • GET /api/menu/burgers - List all burgers.
    • Supported query parameters: name, minPrice, maxPrice.
  • GET /api/menu/burgers/{id} - Retrieve detailed info for a specific burger.

Drinks

  • GET /api/menu/drinks - List all drinks.
    • Supported query parameters: name, minPrice, maxPrice.
  • GET /api/menu/drinks/{id} - Retrieve detailed info for a specific drink.

Deployment & Testing

  • Swagger UI: Accessible at /swagger-ui/index.html for interactive testing.
  • Testing: Automated tests cover endpoint status codes and content-type validation.
  • Containerization: Included Dockerfile for standardized deployment across different environments.

Local Access Points

About

API I had to do in 3h for coding challenge to apply for internship

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages