Giter VIP home page Giter VIP logo

book-manager-api's Introduction

๐Ÿ“– Minimalist Book Manager API

Introduction

This is the starter repository for the Further APIs session. It provides a start to creating a Minimalist Book Manager API using a Test-Driven Development approach.

Pre-Requisites

  • Java SE Development Kit 11
  • Maven

Technologies & Dependencies

  • Spring Boot
  • Spring Web
  • H2 Database
  • Lombok
  • Spring Data JPA

How to Get Started

  • Fork this repo to your Github and then clone the forked version of this repo

Main Entry Point

Running the Unit Tests

  • You can run the unit tests in IntelliJ, or you can go to your terminal and inside the root of this directory, run:

mvn test

Tasks

Here are some tasks for you to work on:

๐Ÿ“˜ Discussion Task

Explore the code and make notes on the following features and how it is being implemented in the code. We'd like you to note down what classes and methods are used and how the objects interact.

The features are:

  • Get All Books
    • GET request with no parameter
  • Get a Book by ID
    • GET request with book id as parameter
  • Add a Book
    • POST request with book as body
  • Update a Book
    • PUT request with book id as parameter and with book as body

Seriously do not like the "hidden" nature of so much of this. I missed the "endpoint" definition the first time through as it was stuck up behind the class definition. Only went looking for it when I saw the endpoint being used in the test code and tried to work out why it was there. Can only guess that the annotations are doing behind the scenes in the Book Model class! And there does not seem to be much of an actual repository as the Tests mock it anyway.

All the above "enter" in the "BookManagerController" as either GET, POST or PUT requests with endpoint as "/api/v1/book" and an optional bookID parameter, and optional Book body.

These are then processed by the "BookManagerServiceImpl" to access some back end repository and either update and / or return data from that repository.

The BookManagerController then packages the result as "ResponseEntity" to be returned to the user.
I can be assumed that this is a JSON body (representing the Book object), a status code and optional headers.

๐Ÿ“˜ Task 1: Implement the following User Story with tests.

User Story: As a user, I want to use the Book Manager API to delete a book using its ID

Implementation:

  • Task 1 added test
  • Added control mapping for delete

๐Ÿ“˜ Extension Task: Oh no! ๐Ÿ˜ญ We've only covered the happy paths in the solution, can you figure out a way to add in exception handling to the project?

  • Clue 1: What if someone wants to add a book with an ID for a book that already exists? How do we handle this gracefully?

  • Clue 2: What if someone wants to find a book by an ID that doesn't yet exist? How can we improve the API by handling errors gracefully and show a helpful message to the client?

Implementation:

  • Added tests for get, put and delete for missing bookId's

API Interactive Lab 2 - Externalising Application Configuration &Connecting to a Real Database - MySQL Version

  1. Explore the Spring Boot INFO logs
  • See: No active profile set
  • See: Using dialect: org.hibernate.dialect.H2Dialect
  1. Getting to know the application.properties file
  • Found the exisitng properties
  1. Connecting your Minimalist Book Manager API to a MySQL Database
    • Added the MySQL Dependency to POM
    • Added the Database Connection String to the application.properties file
    • Dropped the existing Book table and created by Spring ....
    • Added books
    • Got them back as list
    • Checked they were there after server restart
  2. Creating different application.properties files for various environments
  3. (Optional) Move password to environment variables
    • Actually placed the property in the configuration file for the Application

book-manager-api's People

Contributors

kimdiep avatar tinka8ell avatar eggsy84 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.