API Documentation - avaiaco/get-that-bread GitHub Wiki
F. API Documentation
Purpose: Document the Web APIs and your own cloud functions used by the app, including endpoints, request methods, and data formats. API Endpoints: List of API endpoints with descriptions of their purpose. Request and Response Formats: Details of the expected request and response formats, including headers, parameters, and body content. If JSON is used, then provide the JSON schema. Authentication: Description of any authentication mechanisms used (e.g. API keys and how they are managed).
API Endpoints
- Google Gemini API for Daily Recipe
Base URL: https://myai-blrtic52wa-uc.a.run.app
Endpoint: /api/v0/gtb/[recipes].json
Request Method: POST
Purpose: This endpoint returns a generated recipe for the user.
Body: The API returns a JSON with various a gluten free recipe. An example is given:
{ "response_text": "One-Pan Lemon Herb Roasted Chicken and Veggies\n\nIngredients:\n\n1 lb boneless, skinless chicken thighs\n1 lb broccoli florets\n1 red bell pepper, chopped\n1 lemon, sliced\n2 tbsp olive oil\n1 tsp dried oregano\n1 tsp dried thyme\nSalt and pepper to taste\n\nInstructions:\n\nPreheat oven to 400°F (200°C).\nToss veggies and chicken with olive oil, herbs, salt, and pepper.\nArrange on a baking sheet. Top with lemon slices.\nRoast for 25-30 minutes, or until chicken is cooked through.\n" }
Authentication This API is authenticated through Firebase.
API Endpoints
- Google Gemini API for the ChatBot
Base URL: https://myai-2xyl3drhhq-uc.a.run.app
Endpoint: /api/v0/gtb/[breadbot].json
Request Method: POST
Purpose: User submits a prompt for the API to analyze, and the API returns a resposne.
Body: The API returns a JSON with a response.
{ "prompt": "f" "response_text": "I don't understand. Please provide more information." }
Authentication: Authentication is done via Firebase