This is my second API project, documented via Swagger. I learned to "translate" Express queries from a previous project to Mongoose. The dataset consists of the top 100 streamed songs of all time on Spotify. The source of the data was Kaggle.com, which in turn retrieved it from http://organizeyourmusic.playlistmachinery.com/.
- 8 different routes using Mongoose methods like find, findById, gt and lt.
- Endpoints that return a collection of results: Get all tracks, filter pop tracks, filter tracks by workout or calm moods.
- Endpoints that return a single result: Get track by ID and query parameters: trackName, artistName, genre, year, bpm.
- Error handling by returning 404 status codes when the item is not found.
- Swagger documentation.
- This is an enhancement of my Express API project: https://github.com/isomoth/project-express-api
- The first route was /tracks. First I console.logged the data and then implemented it as the API response.
- Then I proceeded to do the routes that return the collections, and finally the single results (including the ones with query params).
- I created filters that simulate a rudimentary playlist mechanism. One of the routes displays tracks that are suitable for a party by filtering by the danceability parameter. The other two routes filter tracks through the energy parameter to present a collection of workout songs and another with a calm mood.
- The next step was adding some 404 error handling to all routes (this is an improvement from the Express API project, where not all of them had it). In future implementations, I might add error handling for other use cases.
- Last but not least, I documented the API through Swagger.
- The most difficult part about this project was the deployment. Connecting Heroku with MongoDB Cloud Atlas took a while to figure out. But the app's documentation combined with a detailed inspection of Heroku logs helped a lot.
- The second biggest challenge was the API documentation through Swagger. I had to search for different sources because the official docs were a bit confusing. And it also took a bit of practice to get used to YAML.
- Documented version: https://project-mongo-api-glyx3a37va-lz.a.run.app/api-docs
- Heroku version: https://project-mongo-api-glyx3a37va-lz.a.run.app