The X-Press Publishing internal tool allows users to:
- Create, view, and update artists
- Create, view, update, and delete comic book series
- Create, view, update, and delete issues of a specific comic book series
To test this functionality you can run the testing suite and interact with the API via the provided front-end. If you want more data to interact with in the front-end, you can run the seed.js file to add data to your database.
-
Artist
- id - Integer, primary key, required
- name - Text, required
- date_of_birth - Text, required
- biography - Text, required
- is_currently_employed - Integer, defaults to
1
-
Series
- id - Integer, primary key, required
- name - Text, required
- description - Text, required
-
Issue
- id - Integer, primary key, required
- name - Text, required
- issue_number - Text, required
- publication_date - Text, required
- artist_id - Integer, foreign key, required
- series_id - Integer, foreign key, required
/api/artists
- GET
- Returns a 200 response containing all saved currently-employed artists (
is_currently_employed
is equal to1
) on theartists
property of the response body
- Returns a 200 response containing all saved currently-employed artists (
- POST
- Creates a new artist with the information from the
artist
property of the request body and saves it to the database. Returns a 201 response with the newly-created artist on theartist
property of the response body - If any required fields are missing, returns a 400 response
- Creates a new artist with the information from the
/api/artists/:artistId
- GET
- Returns a 200 response containing the artist with the supplied artist ID on the
artist
property of the response body - If an artist with the supplied artist ID doesn't exist, returns a 404 response
- Returns a 200 response containing the artist with the supplied artist ID on the
- PUT
- Updates the artist with the specified artist ID using the information from the
artist
property of the request body and saves it to the database. Returns a 200 response with the updated artist on theartist
property of the response body - If any required fields are missing, returns a 400 response
- If an artist with the supplied artist ID doesn't exist, returns a 404 response
- Updates the artist with the specified artist ID using the information from the
- DELETE
- Updates the artist with the specified artist ID to be unemployed (
is_currently_employed
equal to0
). Returns a 200 response. - If an artist with the supplied artist ID doesn't exist, returns a 404 response
- Updates the artist with the specified artist ID to be unemployed (
/api/series
- GET
- Returns a 200 response containing all saved series on the
series
property of the response body
- Returns a 200 response containing all saved series on the
- POST
- Creates a new series with the information from the
series
property of the request body and saves it to the database. Returns a 201 response with the newly-created series on theseries
property of the response body - If any required fields are missing, returns a 400 response
- Creates a new series with the information from the
/api/series/:seriesId
- GET
- Returns a 200 response containing the series with the supplied series ID on the
series
property of the response body - If a series with the supplied series ID doesn't exist, returns a 404 response
- Returns a 200 response containing the series with the supplied series ID on the
- PUT
- Updates the series with the specified series ID using the information from the
series
property of the request body and saves it to the database. Returns a 200 response with the updated series on theseries
property of the response body - If any required fields are missing, returns a 400 response
- If a series with the supplied series ID doesn't exist, returns a 404 response
- Updates the series with the specified series ID using the information from the
- DELETE
- Deletes the series with the supplied series ID from the database if that series has no related issues. Returns a 204 response.
- If the series with the supplied series ID has related issues, returns a 400 response.
- If a series with the supplied series ID doesn't exist, returns a 404 response
/api/series/:seriesId/issues
- GET
- Returns a 200 response containing all saved issues related to the series with the supplied series ID on the
issues
property of the response body - If a series with the supplied series ID doesn't exist, returns a 404 response
- Returns a 200 response containing all saved issues related to the series with the supplied series ID on the
- POST
- Creates a new issue, related to the series with the supplied series ID, with the information from the
issue
property of the request body and saves it to the database. Returns a 201 response with the newly-created issue on theissue
property of the response body - If any required fields are missing or an artist with the supplied artist ID doesn't exist, returns a 400 response
- If a series with the supplied series ID doesn't exist, returns a 404 response
- Creates a new issue, related to the series with the supplied series ID, with the information from the
/api/series/:seriesId/issues/:issueId
- PUT
- Updates the issue with the specified issue ID using the information from the
issue
property of the request body and saves it to the database. Returns a 200 response with the updated issue on theissue
property of the response body - If any required fields are missing, returns a 400 response
- If a series with the supplied series ID doesn't exist, returns a 404 response
- If an issue with the supplied issue ID doesn't exist, returns a 404 response
- Updates the issue with the specified issue ID using the information from the
- DELETE
- Deletes the issue with the supplied issue ID from the database. Returns a 204 response.
- If a series with the supplied series ID doesn't exist, returns a 404 response
- If an issue with the supplied issue ID doesn't exist, returns a 404 response
A testing suite has been provided for you, checking for all essential functionality and edge cases.
To run these tests, first, open the root project directory in your terminal. Then run npm install
to install all necessary testing dependencies (if you haven't already). Finally, run npm test
. You will see a list of tests that ran with information about whether or not each test passed. After this list, you will see more specific output about why each failing test failed.