https://github.com/alpermulayim/openfoodfacts-spring-boot-starter
OpenFoodFacts Spring Boot Starter custom webclient and maven package for OpenFoodFacts easy integrations with OpenFoodFacts Rest Api
https://github.com/alpermulayim/openfoodfacts-spring-boot-starter
api customspringbootstarter java openfoodfacts openfoodfactsapi openfoodfactsrestfulapi openfoodfactsspringbootstarter restful-api spring spring-boot-starter spring-boot-starter-openfoodfacts springboot trending webclient webclient-springboot
Last synced: 5 months ago
JSON representation
OpenFoodFacts Spring Boot Starter custom webclient and maven package for OpenFoodFacts easy integrations with OpenFoodFacts Rest Api
- Host: GitHub
- URL: https://github.com/alpermulayim/openfoodfacts-spring-boot-starter
- Owner: AlperMulayim
- Created: 2025-02-19T18:09:33.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-28T14:08:18.000Z (over 1 year ago)
- Last Synced: 2025-02-28T19:48:03.909Z (over 1 year ago)
- Topics: api, customspringbootstarter, java, openfoodfacts, openfoodfactsapi, openfoodfactsrestfulapi, openfoodfactsspringbootstarter, restful-api, spring, spring-boot-starter, spring-boot-starter-openfoodfacts, springboot, trending, webclient, webclient-springboot
- Language: Java
- Homepage:
- Size: 89.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# OpenFoodFacts Spring Boot Starter Maven Package SDK.
| Github Page
javadoc and more |Author
Alper Mulayim | JavaDoc|
|----------|----------|------------|
| [](https://alpermulayim.github.io/openfoodfacts-spring-boot-starter/) | [](https://www.linkedin.com/in/alpermulayim/) |[JavaDoc](https://alpermulayim.github.io/openfoodfacts-spring-boot-starter/javadocs/com/alpermulayim/openfoodfacts_spring_boot_starter/OpenFoodFactsApi.html) |
**openfoodfacts-spring-boot-starter**
Package designed to **simplify the integration of OpenFoodFacts REST APIs into Spring Boot** applications.
Developers can easily connect to the OpenFoodFacts API without implement any complex RESTful calls.
**OpenFoodFactsWebClient** **OpenFoodFactsApi** current version provides different methods for product and search.
```java
OpenFoodFactsResponse getProduct(String productCode, List fields);
OpenFoodFactsResponse getProduct(String productCode);
OpenFoodFactsResponse getProduct(ProductRequest request);
OpenFoodFactsPageResponse searchProduct(ProductSearchRequest request) throws InvocationTargetException, IllegalAccessException , OpenFoodFactsException;
OpenPriceFactsResponse findPrice(PriceRequest priceRequest);
OpenPriceFactsResponse findPrice(String productCode);
OpenPriceLocationsPagedResponse findPriceLocation(PriceLocationRequest locationRequest);
ProductSaveResponse saveProduct(ProductSaveRequest request);
Mono> uploadProductImage(ProductImageUploadRequest request);
String uploadProductImageBlocked(ProductImageUploadRequest request) throws OpenFoodFactsException;
Mono> uploadProductImageUnblocked(ProductImageUploadRequest request) throws OpenFoodFactsException;
```
# Installation How To Use
## Local Installation
**Clone or fork** the repository.
**cd openfoodfacts-springboot-starter**
**mvn clean install**
check the repositories added. **cd ~/.m2**
Add **openfoodfacts-springboot-starter** dependency to your spring boot **pom.xml**
```java
org.openfoodfacts
openfoodfacts-spring-boot-starter
0.0.1
```
## Installation Online Latest Github Package
**Note:** Latest package is deployed to [https://github.com/AlperMulayim/openfoodfacts-spring-boot-starter/packages/](https://github.com/AlperMulayim/openfoodfacts-spring-boot-starter/packages/) Please check the latest version.
**Add github repositories to pom.xml**
```java
github
https://maven.pkg.github.com/AlperMulayim/openfoodfacts-spring-boot-starter
```
**Add openfoodfacts-spring-boot-starter dependecy to your pom.xml**
Please check latest version on [https://github.com/AlperMulayim/openfoodfacts-spring-boot-starter/packages/](https://github.com/AlperMulayim/openfoodfacts-spring-boot-starter/packages/)
```java
com.alpermulayim
openfoodfacts-spring-boot-starter
0.0.2.8
```
**Install the dependencies**
```java
mvn clean install
cd ~/.m2 // check the repositories downloaded.
```
## Configuration
**Create configuration file** for OpenFoodFactsWebClientProperties OpenFoodFactsWebClient beans.
```java
@Configuration
public class DemoConfig {
OpenFoodFactsWebClientProperties properties;
@Autowired
public DemoConfig(OpenFoodFactsWebClientProperties properties) {
this.properties = properties;
}
@Bean
OpenFoodFactsApi openFoodFactsWebClient(){
return new OpenFoodFactsWebClient(properties);
}
}
```
**Customizable endpoints and paths via application.yml or application.properties files**
You are able to customize starter endpoints and base urls, if you do not customize webclient have default configuration.
```java
openfoodfacts:
base-url: "https://world.openfoodfacts.org"
prices-base-url: "https://prices.openfoodfacts.org",
search-path: "/api/v2/search"
product-path: "/api/v2/product"
prices-path:"/api/v1/prices"
username: "${OPEN_FOOD_FACTS_USERNAME}"
password: "${OPEN_FOOD_FACTS_PASSWORD}"
```
## **Ready to use 🎉**
Sample codes and configuration please check [openfoodfacts-starter-demo](https://github.com/AlperMulayim/openfoodfacts-spring-boot-starter/tree/main/openfoodfacts-starter-demo)
Demo Application README: [Demo Application Readme](https://github.com/AlperMulayim/openfoodfacts-spring-boot-starter/blob/main/DemoApp-README.md)
```java
@Service
public class DemoOpenFoodFactsService {
@Autowired
OpenFoodFactsApi webClient;
public OpenFoodFactsResponse request(){
//we are able to create selected fields via ProductField.
List fields = new ArrayList<>();
fields.add(ProductField.PRODUCT_NAME);
fields.add(ProductField.CODE);
fields.add(ProductField.NUTRISCORE_SCORE);
fields.add(ProductField.IMAGE_URL);
fields.add(ProductField.NUTRISCORE_DATA);
fields.add(ProductField.NUTRITION_GRADES);
fields.add(ProductField.BRANDS);
fields.add(ProductField.INGREDIENTS_TEXT);
return webClient.getProduct("5449000000996",fields);
}
public OpenFoodFactsResponse request(String productCode){
return webClient.getProduct(productCode);
}
public OpenFoodFactsPageResponse search(ProductSearchRequest request)
throws InvocationTargetException, IllegalAccessException {
return webClient.searchProduct(request);
}
public OpenFoodFactsPageResponse searchCustom() throws InvocationTargetException, IllegalAccessException {
List fields = new ArrayList<>();
fields.add(ProductField.PRODUCT_NAME);
fields.add(ProductField.CODE);
fields.add(ProductField.IMAGE_URL);
fields.add(ProductField.BRANDS);
fields.add(ProductField.INGREDIENTS_TEXT);
ProductSearchRequest request = ProductSearchRequest.builder()
.brandsTags("nutella")
.pageSize(3)
.fields(fields)
.build();
return webClient.searchProduct(request);
}
public List searchDemoProducts() {
//will request for ETI products total 5.
ProductSearchRequest request = searchRequest("eti",5);
OpenFoodFactsPageResponse response = webClient.searchProduct(request);
//convert the OpenFoodFacts product to custom product
return response.products().stream()
.map(product ->new DemoProduct(product.code(), product.product_name(),product.imageUrl()))
.collect(Collectors.toList());
}
}
```
### OpenPrices Demo Usecase
```java
public OpenPriceFactsResponse getProductPrice(String productCode){
return webClient.findPrice(productCode);
}
public OpenPriceFactsResponse searchPrice(PriceRequest request){
return webClient.findPrice(request);
}
public OpenPriceFactsResponse searchPriceCustom(){
PriceRequest priceRequest = PriceRequest.builder()
.priceGt(2.0)
.priceLt(5.0)
.size(3)
.build();
return webClient.findPrice(priceRequest);
}
public List myDemoSearchMyProductPrices(){
PriceRequest priceRequest = PriceRequest.builder()
.priceGt(2.0)
.priceLt(5.0)
.build();
OpenPriceFactsResponse priceResponse = webClient.findPrice(priceRequest);
return priceResponse.prices().stream()
.map(productPrice -> createDemoPrice(productPrice))
.collect(Collectors.toList());
}
private DemoPrice createDemoPrice(ProductPrice productPrice){
String productName = productPrice.productName();
String productCode = productPrice.productCode();
String brand = productPrice.product().brands();
String country = productPrice.location().osmAddressCountryCode();
Double price = productPrice.price();
String currency = productPrice.currency();
String store = productPrice.location().osmBrand();
String imageUrl = productPrice.product().imageUrl();
return new DemoPrice(productCode,productName,brand,store,country,currency,price,imageUrl);
}
```
### Product Save Demo Usecase
``````java
public ProductSaveResponse saveProductCustom(){
ProductSaveRequest request = ProductSaveRequest.builder()
.code("484848484")
.brands("fakebrand-test")
.productName("fakeproduct-test")
.ingredientsText("fake,ingredients,test1,test2,test3")
.comment("fake,comment")
.build();
return webClient.saveProduct(request);
}
``````
### Image Upload Demo Usecase
```````java
public String uploadProductImage(String code, String lang, String facet, MultipartFile file) throws IOException {
ProductImageUploadRequest request = ProductImageUploadRequest.builder()
.productCode(code)
.language(Language.fromCode(lang))
.file(file)
.facet(facet)
.build();
return webClient.uploadProductImage(request);
}
```````
### Author [Alper Mulayim](https://github.com/AlperMulayim) connect with me!
[](https://www.linkedin.com/in/alpermulayim/)