IanTDuncan / MealTime

Project for CSC 480
0 stars 0 forks source link

API - Spoonacular - API Investigation #132

Closed IanTDuncan closed 4 months ago

IanTDuncan commented 4 months ago

API - Spoonacular API Investigation


Description:

This is an investigation I've done into Spoonacular. The objective of this investigation is to identify which of the Spoonacular APIs are best suited for MealTime's many services. As such I will try and keep the various Spoonacular API services within their various categories.


Initial Findings:

Based on the documentation here. Spoonacular has plenty of APIs, but the majority of ones we'll be using are from the Meal Planning Section along with a few from the Recipe section.


Steps For Investigation:

  1. Identify what services our app is using
  2. Identify which of the services Spoonacular API offers match up to the ones we want
  3. Select those APIs and investigate them more thoroughly

Results of Investigation:

Meal Planning

Recipes


Next Steps:

Get feedback and suggestions from teammates about which APIs to work on.


Environment Details:

Operating System: Windows 11


Current Status:

COMPLETED

BeepDroid commented 4 months ago

Spoonacular API Investigation


Description


Responding to Ian's initial commit to this issue with an additional idea for one of the APIs, but the ones he's listed thus far I already completely agree with using. Further down in this post I'll also be listing the resources I've found that have to do with using and implementing Spoonacular API for easier access during our development.

Initial Findings


@IanTDuncan I think another one we can add, time willing, would probably be "Get Similiar Recipes" from the document link you provided. Again, only if time allows, it can be something we leave last in the case we have to start shaving off features.

As for our resources, this is what I have so far: A walkthrough by Reintech -- This is a walkthrough on how to get started with the Recipe API using Postman as a resource,; Postman, which will be posted further down, is an alternative to the SDK if needed. This is a video walkthrough for the same API using Retrofit -- This is an implementation of the Random Recipe Spoonacular API through a multi-step video walkthrough of connection and implementation using Retrofit. A Video on how to get started with Spoonacular -- This addresses things like your user key and how to do API calls. Another full tutorial on how to implement the API -- This pretty much takes us on the entire creation of an app from start to finish with the Spoonacular API; however, it isn't in English. I think we can still follow along the logic seeing it being typed out.

Next Steps:


Begin connection ASAP while going through all our resources and documentation.

Current Status:


In progress

IanTDuncan commented 4 months ago

@BeepDroid Will definitely look into those tutorial @aaleksandraristic Is it okay if I close this issue? I believe I have gotten all the suggestions that I think people will give

aaleksandraristic commented 4 months ago

@IanTDuncan Sorry for my late response, yes, go ahead and close the issue. Then for each of these implementations, you should create separate issues.