azure-spring-boot/README.md

9.2 KiB

Travis CI AppVeyor codecov MIT License Gitter

Azure Spring Boot

Introduction

This repo is for Spring Boot Starters of Azure services. It helps Spring Boot developers to adopt Azure services.

Support Spring Boot

This repository supports both Spring Boot 1.5.x, 2.0.x and 2.1.x. Please read Branch and release for branch mapping.

Prerequisites

  • JDK 1.8 and above
  • Maven 3.0 and above

Usage

Below starters are available with latest release version. We recommend users to leverage latest version for bug fix and new features. You can find them in Maven Central Repository. The first three starters are also available in Spring Initializr.

Starter Name Version for Spring Boot 2.1.x Version for Spring Boot 2.0.x
azure-active-directory-spring-boot-starter Maven Central
azure-storage-spring-boot-starter Maven Central
azure-keyvault-secrets-spring-boot-starter Maven Central
azure-active-directory-b2c-spring-boot-starter Maven Central N/A
azure-cosmosdb-spring-boot-starter Maven Central
azure-mediaservices-spring-boot-starter Maven Central
azure-servicebus-spring-boot-starter Maven Central
spring-data-gremlin-boot-starter Maven Central
azure-spring-boot-metrics-starter Maven Central

Snapshots

Nexus OSS

Snapshots built from master branch are available, add maven repositories configuration to your pom file as below.

<repositories>
  <repository>
    <id>nexus-snapshots</id>
    <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
    <snapshots>
      <enabled>true</enabled>
      <updatePolicy>always</updatePolicy>
    </snapshots>
  </repository>
</repositories>

How to Build and Contribute

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

Please follow instructions here to build from source or contribute.

You could check below articles to learn more on usage of specific starters.

How to use the Spring Boot Starter with Azure Cosmos DB DocumentDB API

Filing Issues

If you encounter any bug, please file an issue here.

To suggest a new feature or changes that could be made, file an issue the same way you would for a bug.

You can participate community driven Gitter

Pull Requests

Pull requests are welcome. To open your own pull request, click here. When creating a pull request, make sure you are pointing to the fork and branch that your changes were made in.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Data/Telemetry

This project collects usage data and sends it to Microsoft to help improve our products and services. Read our privacy statement to learn more.