Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/watson-developer-cloud/spring-boot-starter

Spring Boot support for Watson services
https://github.com/watson-developer-cloud/spring-boot-starter

hacktoberfest ibm-watson-services spring-boot spring-boot-starter watson watson-conversation watson-developer-cloud watson-discovery watson-language-translator watson-natural-language-classifier watson-service

Last synced: about 1 month ago
JSON representation

Spring Boot support for Watson services

Host: GitHub
URL: https://github.com/watson-developer-cloud/spring-boot-starter
Owner: watson-developer-cloud
License: apache-2.0
Created: 2018-01-02T15:22:39.000Z (almost 7 years ago)
Default Branch: master
Last Pushed: 2022-01-27T21:56:38.000Z (almost 3 years ago)
Last Synced: 2024-05-09T16:21:26.600Z (6 months ago)
Topics: hacktoberfest, ibm-watson-services, spring-boot, spring-boot-starter, watson, watson-conversation, watson-developer-cloud, watson-discovery, watson-language-translator, watson-natural-language-classifier, watson-service
Language: Java
Homepage:
Size: 322 KB
Stars: 13
Watchers: 31
Forks: 14
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

# Watson Spring Boot

[![Build and Test](https://github.com/watson-developer-cloud/spring-boot-starter/actions/workflows/build-test.yml/badge.svg)](https://github.com/watson-developer-cloud/spring-boot-starter/actions/workflows/build-test.yml)
[![Deploy and Publish](https://github.com/watson-developer-cloud/spring-boot-starter/actions/workflows/deploy.yml/badge.svg)](https://github.com/watson-developer-cloud/spring-boot-starter/actions/workflows/deploy.yml)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.ibm.watson.developer_cloud/watson-spring-boot-starter/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.ibm.watson.developer_cloud/watson-spring-boot-starter)
[![CLA assistant](https://cla-assistant.io/readme/badge/watson-developer-cloud/spring-boot-starter)](https://cla-assistant.io/watson-developer-cloud/spring-boot-starter)

## Deprecated builds
[![Build Status](https://travis-ci.org/watson-developer-cloud/spring-boot-starter.svg?branch=master)](https://travis-ci.org/watson-developer-cloud/spring-boot-starter)

This project adds Spring Boot support for the Watson services.

This means that you can now "auto-wire" any of the Watson services into your Spring Boot application
using the standard Spring autoconfiguration framework.

## Usage

All you need to do is:

1. Add the Watson `watson-spring-boot-starter` dependency to your Spring Boot app:

In your maven `pom.xml`
```

com.ibm.watson.developer_cloud
watson-spring-boot-starter
2.3.6

```

or in your gradle `build.gradle`, in the dependencies stanza, add
```
compile 'com.ibm.watson.developer_cloud:watson-spring-boot-starter:2.3.6'
```

2. Add your Watson service(s) credentials and version info to your application
properties file. The standard location for application properties is the
`src/main/resources/application.properties` file, but your application might
use a different location. The properties to add are:

- `watson..url`: The base URL for the service. This can be omitted if your
service uses the default service url
- `watson..username` and `watson..password` OR `watson..apiKey` OR `watson..iamApiKey`:
The credentials for accessing the service.
The credentials can be omitted from the application properties file if they are
supplied through the `VCAP_SERVICES` environment variable.
- `watson..versionDate`: Some Watson services use a `versionDate` parameter to
indicate the service behavior expected by the application. For services that accept it,
this is a required parameter and must be specified in the application properties.

Both Eclipse and IntelliJ (Ultimate Edition) offer autocomplete support for
Spring Boot application properties and should show these properties, along with
their required type and Javadoc description, in the autocomplete menu.

3. Autowire the service into your application. Autowiring is the key mechanism of the
Spring framework for injecting dependencies. It is accomplished by specifying the
`@Autowired` annotation on the declaration for the service instance.
Here's an example using the Watson Conversation service:
```java
@Autowired
protected Conversation service;
```

The Spring framework takes care of the rest. Your application can now simply start
using the service instance.

## Open Source @ IBM

Find more open source projects on the [IBM Github Page](http://ibm.github.io/)

## License

This library is licensed under Apache 2.0. Full license text is
available in [LICENSE](LICENSE).

## Contributing

See [CONTRIBUTING.md](.github/CONTRIBUTING.md).

## Code of Conduct

See [CODE_OF_CONDUCT.md](.github/CODE_OF_CONDUCT.md).

### Other

If you are having difficulties using the APIs or you have a question about the IBM
Watson Services, please ask a question on
[dW Answers](https://developer.ibm.com/answers/questions/ask/?topics=watson)
or [Stack Overflow](http://stackoverflow.com/questions/ask?tags=ibm-watson).