Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ibm/cloudant-spring

cloudant spring spring-boot spring-framework

Last synced: 3 months ago
JSON representation

Host: GitHub
URL: https://github.com/ibm/cloudant-spring
Owner: IBM
License: apache-2.0
Created: 2017-11-29T15:56:01.000Z (about 7 years ago)
Default Branch: main
Last Pushed: 2024-10-11T10:53:49.000Z (3 months ago)
Last Synced: 2024-10-11T16:05:24.251Z (3 months ago)
Topics: cloudant, spring, spring-boot, spring-framework
Language: Java
Size: 467 KB
Stars: 11
Watchers: 7
Forks: 12
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

# Cloudant Spring Boot Starter

This project is a "Spring Boot starter" which allows users to get up and running quickly with the official
[Cloudant SDK for Java](https://github.com/IBM/cloudant-java-sdk) in Spring boot applications as well
as providing autoconfiguration via `application.properties` or another configuration source (environment, java properties, etc)

_Note this library is experimental and not covered by IBM Cloudant support._
_If you have problems using the library please refer to [issues](#issues)._

## Using

See the [sample](sample) directory which provides an example application with the following features:

- A Spring Boot MVC application
- Some REST endpoints
- Configuration properties (prefixed `cloudant.`) which are automatically loaded by the Cloudant client
- Other customer configuration properties (in this case named `myconfig.db`)

The sample has two rest endpoints, `/all_dbs` which returns a list of all databases for the Cloudant account, and
`/all_docs` which returns a list of all document ids for the database configured at `myconfig.db`.

To run the sample, you will need to edit the `application.properties` file, substituting your own settings as necessary:

```properties
cloudant.auth.type=iam
cloudant.url=https://-bluemix.cloudantnosqldb.appdomain.cloud
cloudant.apikey=my-iam-api-key
myconfig.db=my-test-db
```

Run application:

```shell
gradle bootRun
```

Now with the example web app running you can make REST requests to it (e.g. with `curl`).

REST request for `all_dbs`:
```shell
curl localhost:8080/all_dbs
test-db-04178485-8f15-4c3b-9138-d6ed68edb1d4
test-db-07b6c52a-e2e9-4da5-b641-6233367f8af9
test-db-0810edcf-fff6-4093-af01-f081fda77e74
test-db-08d3cef8-50db-42a5-af9f-991493cbce50
test-db-0c8255b0-ee10-4d4c-b104-def796305ebe
...
```

REST request for `all_docs`:
```shell
curl localhost:8080/all_docs
4826c5d0c7c9eba0babc7a17699405af
6070d2165fd43a19bd0c51858b4597cc
856599e6ffb52f47532e280de607146d
f28fa5b29ca5aed35ba28803401d17a7
fd6d29a324e4ac7d972d15d577a36524
...
```

## Properties metadata

The jar is built with `spring-configuration-metadata.json` which gives extra properties metadata and hints
when editing a properties file in some IDEs. See screenshots below for examples:

![](Screenshot%20from%202022-06-29%2012-26-27.png)

![](Screenshot%20from%202022-06-29%2012-27-38.png)

## Issues

Before opening a new issue please consider the following:
* Please try to reproduce the issue using the latest version.
* Please check the [existing issues](/issues)
to see if the problem has already been reported. Note that the default search
includes only open issues, but it may already have been closed.
* When opening a new issue [here in github](/issues) please complete the template fully.