WCCI Course Materials

Module 5

RESTful API Creation and Single Page Applications

Weekly Pages

Git Workflow

Feature Branch Workflow

Group Project - Album Collection

Assignment Link

Album Collection

Objective

Our super hip ironic friend needs an easy way to curate soundscapes for the Italian scooter/coffee hybrid co-op startup at which they volunteer (they also fix old polaroid cameras).

They have tasked us with creating an application that can easily keep track of their EXTENSIVE record collection and access music by artists, albums, or individual tracks. This collection is in a constant state of flux, so it is essential for the users to be able to update the collection and it's elements.

API Creation

First, we are going to need to create an API using Spring that will handle our DB and interactions with it.

Requirements

  • Create a RESTful API with Spring Boot.

    • Endpoints for the following:

    • All CRUD operations for artists

      • Create endpoint
      • Read endpoint
      • Update endpoint
      • Delete endpoint

    • All CRUD operations for albums

      • Create endpoint
      • Read endpoint
      • Update endpoint
      • Delete endpoint

    • All CRUD operations for songs

      • Create endpoint
      • Read endpoint
      • Update endpoint
      • Delete endpoint
    • A database service layer for retrieving and storing artists, albums, and songss from the database and interacting with the controllers.
    • Error handling
    • Resource not found
    • Integration testing suite
    • SmokeTests
    • HttpRequestTest
    • Application & WebLayer Tests

Relationships

Our user should be able to:

  • access albums from the artist that made them.
  • access songs from the album the song is on.

User Input Fields

Each entity should have fields the user can interact with:

  • Should have ratings (rating system can be your own design)
  • Should have comments with a way to add them

Administrative Front-end

Next we will crate our administrative front-end. It should be an SPA that uses JS to build out components that our users can interact with. Use modular JS along with WebPack to create reusable components. This application should allow you to create new artists, albums and songs, edit details about each of the items after they have been created, and delete items.

User Interaction

Our users should be able to add new instances of all entities as well as comments and ratings

Entities

artist

  • name
  • image
  • albums

  • any other pertinent info. Could include:

    • age
    • record label
    • hometown

album

  • title
  • image
  • songs
  • record label

song

  • title
  • link (optional)
  • duration

Resources

Pair Programming

JS

APIs

Mastery

Kata Mastery