Breaking Bad API

Built with

• Maven - Dependency Management.
• JDK - Java™ Platform, Standard Edition Development Kit.
• Spring Boot - Framework to ease the bootstrapping and development of new Spring Applications.
• H2 - Open-source, in memory lightweight Java database.
• Git - Free and Open-Source distributed version control system.
• Lombok - Never write another getter or equals method again, with one annotation your class has a fully featured builder, Automate your logging variables, and much more.

External Tools Used

• Postman - API Development Environment (Testing Documentation)

Running the application locally

There are several ways to run a Spring Boot application on your local machine. One way is to execute the main method in the com.breakingbad.Application class from your IDE.

• Download the zip or clone the Git repository.
• Unzip the zip file (if you downloaded one)
• Open Command Prompt and Change directory (cd) to folder containing pom.xml
• Open IDE
  • File -> Import -> Navigate to the folder where you unzipped the zip
  • Select the project
• Choose the Spring Boot Application file (search for @SpringBootApplication)
• Right-Click on the file and Run as Java Application

Alternatively you can use the Spring Boot Maven plugin like so:

mvn spring-boot:run

Description

The Breaking Bad API is a collection of information on the Vince Gilligan series Breaking Bad, as well as his incredible spin-off Better Call Saul. This site is designed to make it easy on the developer to see what HTTP requests are possible, and what information is available.

The following information is provided through this API...

Characters
Episodes
Quotes
Deaths

Base Url: https://breakingbadapi.com/documentation

Demo

After you start the application the server will listen on port 8080

• Get all characters
  HTTP GET localhost:8080/characters/all

• Get all deaths
  HTTP GET localhost:8080/deaths/all

• Get all episodes
  HTTP GET localhost:8080/episodes/all

• Get all quotes
  HTTP GET localhost:8080/quotes/all

• Get character by id
  HTTP GET localhost:8080/character/{characterId}

• Get character by name
  HTTP GET localhost:8080/character/{name}

• Get random character
  HTTP GET localhost:8080/character/random

• Get episode by id
  HTTP GET localhost:8080/episode/{episodeId}

• Get random episode
  HTTP GET localhost:8080/episode/random

• Get quote by id
  HTTP GET localhost:8080/quote/{quoteId}

• Get random quote
  HTTP GET localhost:8080/quote/random

• Get random death
  HTTP GET localhost:8080/death/random