https://github.com/charlesmartinreed/album-api-project
https://github.com/charlesmartinreed/album-api-project
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/charlesmartinreed/album-api-project
- Owner: charlesmartinreed
- Created: 2022-10-06T04:59:38.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-11-03T07:26:02.000Z (over 2 years ago)
- Last Synced: 2024-08-01T13:34:19.060Z (7 months ago)
- Language: JavaScript
- Size: 53.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Album API Project
### Just a barebones API used as an backend for a similarly simple web-based music player UI/UX study project, [which can be found here]('https://github.com/charlesmartinreed/design-study-side-panel-ux').
## ROUTES
### GET
- `/api/albums` - returns the full album object, including artist, track list, genre, etc.
- `/api/albums/?limit={limit_value}` - returns the requested number of albums from a pool of album objects, randomized.
- `/api/albums/?search={search_value}` - queries the database for a matching property -- currently `album title` or `song title` -- and returns the full album object for parsing, as JSON.
- `/api/albums/trending` - returns albums that are trending, as well as where they are trending (local, region, global).
- `/api/album/:albumId` - returns a specific album from the database, using the URL param for albumID.
### POST
- `/api/album/:albumId` - used by the front-end client to update album objects; client sends a POST request JSON object containing a prop to update and the value to update it with.