Skip to content

Latest commit

 

History

History
140 lines (104 loc) · 3.24 KB

java-spring-api-marathon.md

File metadata and controls

140 lines (104 loc) · 3.24 KB

Getting Started

et get java-spring-api-marathon
cd java-spring-api-marathon
createdb my_sweet_tunes_development
idea .

For those about to Rock...

The only thing better than writing code is writing music. This simple irrefutable fact has driven you to use your Java skills to find a better way to get your songs out and into the world.

Create Your Table

As a musician
I want to have a digital song repository
So that I can store my songs

Acceptance Criteria:

  • Write a migration to create a table with the following fields
    • Song Title (string)
    • Genre (string)
    • Release Year (int)
    • Explicit Content (boolean)

Create Your Entity

As a musician
I want to be able to create new songs
So that I can share them with my fans

Acceptance Criteria:

  • Create a Songs entity within the models package
    • Utilize Lombok for getters and setters
  • Ensure that all fields are required except for Genre
  • Use Lombok for a ToString method

Create Your Repository and Controller

As a musician
I want to share my songs with the world
So I can teach the world to rock

Acceptance Criteria:

  • Create a SongsRepository which extends the PagingAndSortingRepository
  • Create a Controller to handle request mapping for get requests to songs/new and songs/index

Create Your Songs via Web Form

As a musician
I want to be able to enter songs via a form
To efficiently save my songs
  • Create a form to populate your entity for persistence
  • Create a @PostMapping in your controller
  • Saving your song successfully redirect the user to /songs

List Your Songs

As a musician
I want to see a listing of my songs
So that I can keep an itemized list
  • When a user navigates to /songs they should see a paginated list of songs

List Your Songs via API

As a musician
I want to make my songs available via an API
So web crawlers can find me
  • Create a RestController for your songs
  • visiting /api/v1/songs should display a JSON of your songs

Individual Song Detail via API

As a musician
I want to be able to serve up a single song
So that people can embed my song
  • visiting /api/v1/songs/{id} should display a JSON for the song with the matching ID
  • ensure that the show endpoint has error handling and results in a 404 if the song is not found

Non Core Stories

Validate

As a musician
I want to ensure the form is filled out correctly
So my fans don't see incorrect information

Acceptance Criteria:

  • Title
    • Cannot be empty or just white space
    • Must be a string greater than 0 and less than 26 characters
    • Must be present
  • Genre
    • Cannot be empty or just white space
    • Must be a string greater than 0 and less than 16 characters
    • Cannot contain numbers
  • Release Year
    • Must be in the past
    • Must be 4 digits
    • Must be present
  • Explicit Content
    • Must be present

API-based Song Creation

As a musician
I want to allow others to create songs
So that I don't have to do all the work

Acceptance Criteria:

  • Create a PostMapping for the SongsApiController
  • Ensure using CURL that the endpoint works as expected