github.com/deep-space-cartel/fooddata-central-client-go/v2

Go API client for swagger

The FoodData Central API provides REST access to FoodData Central (FDC). It is intended primarily to assist application developers wishing to incorporate nutrient data into their applications or websites. To take full advantage of the API, developers should familiarize themselves with the database by reading the database documentation available via links on Data Type Documentation. This documentation provides the detailed definitions and descriptions needed to understand the data elements referenced in the API documentation. Additional details about the API including rate limits, access, and licensing are available on the FDC website

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

• API version: 1.0.1
• Package version: 1.0.0
• Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen For more information, please visit https://nal.altarama.com/reft100.aspx?key=FoodData

Installation

Put the package under your project folder and add the following in import:

import "./swagger"

Documentation for API Endpoints

All URIs are relative to https://api.nal.usda.gov/fdc

Class	Method	HTTP request	Description
FDCApi	GetFood	Get /v1/food/{fdcId}	Fetches details for one food item by FDC ID
FDCApi	GetFoods	Get /v1/foods	Fetches details for multiple food items using input FDC IDs
FDCApi	GetFoodsList	Get /v1/foods/list	Returns a paged list of foods, in the 'abridged' format
FDCApi	GetFoodsSearch	Get /v1/foods/search	Returns a list of foods that matched search (query) keywords
FDCApi	GetJsonSpec	Get /v1/json-spec	Returns this documentation in JSON format
FDCApi	GetYamlSpec	Get /v1/yaml-spec	Returns this documentation in JSON format
FDCApi	PostFoods	Post /v1/foods	Fetches details for multiple food items using input FDC IDs
FDCApi	PostFoodsList	Post /v1/foods/list	Returns a paged list of foods, in the 'abridged' format
FDCApi	PostFoodsSearch	Post /v1/foods/search	Returns a list of foods that matched search (query) keywords

Documentation For Models

• AbridgedFoodItem
• AbridgedFoodNutrient
• BrandedFoodItem
• BrandedFoodItemLabelNutrients
• BrandedFoodItemLabelNutrientsCalcium
• BrandedFoodItemLabelNutrientsCalories
• BrandedFoodItemLabelNutrientsCarbohydrates
• BrandedFoodItemLabelNutrientsFat
• BrandedFoodItemLabelNutrientsFiber
• BrandedFoodItemLabelNutrientsIron
• BrandedFoodItemLabelNutrientsPotassium
• BrandedFoodItemLabelNutrientsProtein
• BrandedFoodItemLabelNutrientsSaturatedFat
• BrandedFoodItemLabelNutrientsSugars
• BrandedFoodItemLabelNutrientsTransFat
• FoodAttribute
• FoodAttributeFoodAttributeType
• FoodCategory
• FoodComponent
• FoodListCriteria
• FoodNutrient
• FoodNutrientDerivation
• FoodNutrientSource
• FoodPortion
• FoodSearchCriteria
• FoodUpdateLog
• FoodsCriteria
• FoundationFoodItem
• InlineResponse200
• InputFoodFoundation
• InputFoodSurvey
• MeasureUnit
• Nutrient
• NutrientAcquisitionDetails
• NutrientAnalysisDetails
• NutrientConversionFactors
• RetentionFactor
• SampleFoodItem
• SearchResult
• SearchResultFood
• SrLegacyFoodItem
• SurveyFoodItem
• WweiaFoodCategory

Documentation For Authorization

ApiKeyAuth

• Type: API key

Example

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

1. U.S. Department of Agriculture. Agricultural Research Service.

Sources

• FoodData Central API Guide
• Swagger Hub: FoodData Central API v1.0.1

Dependencies

go install -v github.com/go-critic/go-critic/cmd/gocritic@latest
go install github.com/fzipp/gocyclo/cmd/gocyclo@latest
go install golang.org/x/tools/cmd/goimports@latest