https://github.com/chompfoods/sdk-go
Go SDK for the Chomp Food & Recipe Database API. Use our API to get high-quality data on recipes and 875,000+ branded/grocery foods plus raw ingredients.
https://github.com/chompfoods/sdk-go
api branded chomp data database food go grocery ingredients nutrition raw recipe-api recipes sdk
Last synced: 3 months ago
JSON representation
Go SDK for the Chomp Food & Recipe Database API. Use our API to get high-quality data on recipes and 875,000+ branded/grocery foods plus raw ingredients.
- Host: GitHub
- URL: https://github.com/chompfoods/sdk-go
- Owner: chompfoods
- Created: 2020-01-18T04:34:35.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-03-10T13:18:39.000Z (over 4 years ago)
- Last Synced: 2025-06-08T04:15:19.919Z (4 months ago)
- Topics: api, branded, chomp, data, database, food, go, grocery, ingredients, nutrition, raw, recipe-api, recipes, sdk
- Language: Go
- Homepage: https://chompthis.com/api
- Size: 274 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Go API client for swagger
## Important An **[API key](https://chompthis.com/api/)** is required for access to this API. * Get a **Food Data API** key at **[https://chompthis.com/api](https://chompthis.com/api/)**. * Get a **Recipe Data API** key at **[https://chompthis.com/api/recipes](https://chompthis.com/api/recipes/)**. ### Getting Started * Subscribe to the **[Food Data API](https://chompthis.com/api/#pricing)** or the **[Recipe Data API](https://chompthis.com/api/recipes/#pricing)**. * Scroll down and click the \"**Authorize**\" button. * Enter your API key into the \"**value**\" input, click the \"**Authorize**\" button, then click the \"**Close**\" button. * Scroll down to the section titled \"**default**\" and click on the API endpoint you wish to use. * Click the \"**Try it out**\" button. * Enter the information the endpoint requires. * Click the \"**Execute**\" button. ### Example * Branded food response object: **[View example »](https://raw.githubusercontent.com/chompfoods/examples/master/branded-food-response-object.json)** * Ingredient response object: **[View example »](https://raw.githubusercontent.com/chompfoods/examples/master/ingredient-response-object.json)** * Recipe response object: **[View example »](https://raw.githubusercontent.com/chompfoods/examples/master/example-recipe-response.json)** * Error response object: **[View example »](https://raw.githubusercontent.com/chompfoods/examples/master/error-response-object.json)** ### How Do I Find My API Key? * Your API key was sent to the email address you used to create your subscription. * You will also find your API key in the **[Client Center](https://chompthis.com/api/manage.php)**. * Read **[this article](https://desk.zoho.com/portal/chompthis/kb/articles/how-do-i-find-my-api-key)** for more information. ### I'm a Premium subscriber. How do I access the API? * All Premium subscribers must pass in a unique user ID for each user on their platform that is accessing data from the Chomp API. A user ID can be any string of letters and numbers that you assign to your user. Simply add \"user_id\" as a URL parameter when calling the API. *You must add a \"user_id\" URL parameter to every call you make to ANY endpoint.* * **Example** > ```ENDPOINT.php?api_key=API_KEY&code=CODE&user_id=USER_ID``` ### Helpful Links * **Help & Support** * [Knowledge Base »](https://desk.zoho.com/portal/chompthis/kb/chomp) * [Support »](https://chompthis.com/api/ticket-new.php) * [Client Center »](https://chompthis.com/api/manage.php) * **Pricing** * [Food Data API Subscription Options »](https://chompthis.com/api/) * [Recipe Data API Subscription Options »](https://chompthis.com/api/recipes/) * [Food Data API Cost Calculator »](https://chompthis.com/api/cost-calculator.php) * [Recipe Data API Cost Calculator »](https://chompthis.com/api/recipes/cost-calculator.php) * **Guidelines** * [Terms & License »](https://chompthis.com/api/terms.php) * [Attribution »](https://chompthis.com/api/docs/attribution.php)
## Overview
This API client was generated by the [swagger-codegen](https://github.com/swagger-api/swagger-codegen) project. By using the [swagger-spec](https://github.com/swagger-api/swagger-spec) from a remote server, you can easily generate an API client.
- API version: 1.0.0-oas3
- Package version: 1.0.0
- Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen
## Installation
Put the package under your project folder and add the following in import:
```golang
import "./swagger"
```
## Documentation for API Endpoints
All URIs are relative to *https://chompthis.com/api/v2*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**FoodBrandedBarcodePhpGet**](docs/DefaultApi.md#foodbrandedbarcodephpget) | **Get** /food/branded/barcode.php | Get a branded food item using a barcode
*DefaultApi* | [**FoodBrandedNamePhpGet**](docs/DefaultApi.md#foodbrandednamephpget) | **Get** /food/branded/name.php | Get a branded food item by name
*DefaultApi* | [**FoodBrandedSearchPhpGet**](docs/DefaultApi.md#foodbrandedsearchphpget) | **Get** /food/branded/search.php | Get data for branded food items using various search parameters
*DefaultApi* | [**FoodIngredientSearchPhpGet**](docs/DefaultApi.md#foodingredientsearchphpget) | **Get** /food/ingredient/search.php | Get raw/generic food ingredient item(s)
*DefaultApi* | [**RecipeIdPhpGet**](docs/DefaultApi.md#recipeidphpget) | **Get** /recipe/id.php | Get a recipe by ID
*DefaultApi* | [**RecipeIngredientPhpGet**](docs/DefaultApi.md#recipeingredientphpget) | **Get** /recipe/ingredient.php | Get recipes using a list of ingredients
*DefaultApi* | [**RecipeRandomPhpGet**](docs/DefaultApi.md#reciperandomphpget) | **Get** /recipe/random.php | Get random popular recipes
*DefaultApi* | [**RecipeSearchPhpGet**](docs/DefaultApi.md#recipesearchphpget) | **Get** /recipe/search.php | Get recipes using a title and optional filters
## Documentation For Models
- [BrandedFoodObject](docs/BrandedFoodObject.md)
- [BrandedFoodObjectCountryDetails](docs/BrandedFoodObjectCountryDetails.md)
- [BrandedFoodObjectDietFlags](docs/BrandedFoodObjectDietFlags.md)
- [BrandedFoodObjectDietLabels](docs/BrandedFoodObjectDietLabels.md)
- [BrandedFoodObjectDietLabelsGlutenFree](docs/BrandedFoodObjectDietLabelsGlutenFree.md)
- [BrandedFoodObjectDietLabelsVegan](docs/BrandedFoodObjectDietLabelsVegan.md)
- [BrandedFoodObjectDietLabelsVegetarian](docs/BrandedFoodObjectDietLabelsVegetarian.md)
- [BrandedFoodObjectItems](docs/BrandedFoodObjectItems.md)
- [BrandedFoodObjectNutrients](docs/BrandedFoodObjectNutrients.md)
- [BrandedFoodObjectPackage](docs/BrandedFoodObjectPackage.md)
- [BrandedFoodObjectPackagingPhotos](docs/BrandedFoodObjectPackagingPhotos.md)
- [BrandedFoodObjectPackagingPhotosFront](docs/BrandedFoodObjectPackagingPhotosFront.md)
- [BrandedFoodObjectPackagingPhotosIngredients](docs/BrandedFoodObjectPackagingPhotosIngredients.md)
- [BrandedFoodObjectPackagingPhotosNutrition](docs/BrandedFoodObjectPackagingPhotosNutrition.md)
- [BrandedFoodObjectServing](docs/BrandedFoodObjectServing.md)
- [IngredientObject](docs/IngredientObject.md)
- [IngredientObjectCalorieConversionFactor](docs/IngredientObjectCalorieConversionFactor.md)
- [IngredientObjectComponents](docs/IngredientObjectComponents.md)
- [IngredientObjectItems](docs/IngredientObjectItems.md)
- [IngredientObjectNutrients](docs/IngredientObjectNutrients.md)
- [IngredientObjectPortions](docs/IngredientObjectPortions.md)
- [RecipeObject](docs/RecipeObject.md)
- [RecipeObjectAttributes](docs/RecipeObjectAttributes.md)
- [RecipeObjectIngredients](docs/RecipeObjectIngredients.md)
- [RecipeObjectItems](docs/RecipeObjectItems.md)
- [RecipeObjectMeta](docs/RecipeObjectMeta.md)
- [RecipeObjectMetaImages](docs/RecipeObjectMetaImages.md)
- [RecipeObjectNutrients](docs/RecipeObjectNutrients.md)
- [RecipeObjectNutrientsCalories](docs/RecipeObjectNutrientsCalories.md)
## Documentation For Authorization
## ApiKeyAuth
- **Type**: API key
Example
```golang
auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)
```
## Author