fix typos (#221)
* fix typos * more typo correction * update released version * more typos * minor
This commit is contained in:
ZhijunZhao
GitHub
Родитель
14f2e2e81b
Коммит
093ccff680
|
|
@ -1,5 +1,5 @@
|
|||
{
|
||||
"releaseVersion": "0.1.9",
|
||||
"releaseVersion": "0.2.0",
|
||||
"moduleNames": [
|
||||
"azure-spring-boot-parent",
|
||||
"azure-spring-boot-bom",
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# How to Build and Contribute
|
||||
This instruction is guideline for building and code contribution.
|
||||
Below are guidelines for building and code contribution.
|
||||
|
||||
## Prequisites
|
||||
## Prerequisites
|
||||
- JDK 1.8 and above
|
||||
- [Maven](http://maven.apache.org/) 3.0 and above
|
||||
|
||||
|
|
@ -11,31 +11,31 @@ To build the project, run maven commands.
|
|||
```bash
|
||||
git clone https://github.com/Microsoft/azure-spring-boot.git
|
||||
cd azure-spring-boot
|
||||
mvnw clean install
|
||||
mvn clean install
|
||||
```
|
||||
|
||||
## Test
|
||||
|
||||
- Run unit tests
|
||||
```bash
|
||||
mvnw clean install
|
||||
mvn clean install
|
||||
```
|
||||
|
||||
- Skip tests execution
|
||||
- Skip test execution
|
||||
```bash
|
||||
mvnw clean install -DskipTests
|
||||
mvn clean install -DskipTests
|
||||
```
|
||||
|
||||
## Version management
|
||||
Developing version naming convention is like `0.1.9-SNAPSHOT`. Release version naming convention is like `0.1.9`. Please don't update version if no release plan.
|
||||
Developing version naming convention is like `0.2.0-SNAPSHOT`. Release version naming convention is like `0.2.0`. Please don't update version if no release plan.
|
||||
|
||||
## CI
|
||||
Both [travis](https://travis-ci.org/Microsoft/azure-spring-boot) and [appveyor](https://ci.appveyor.com/project/yungez/azure-spring-boot) CI is enabled.
|
||||
Both [Travis](https://travis-ci.org/Microsoft/azure-spring-boot) and [Appveyor](https://ci.appveyor.com/project/yungez/azure-spring-boot) CI is enabled.
|
||||
|
||||
## Contribute to code
|
||||
Code contribution is welcome. To contribute to existing code or add new Starter, please make sure below check list are checked.
|
||||
- [ ] Build pass. checkstyle and findbugs is enabled by default. Please check [checkstyle.xml](config/checkstyle.xml) to learn detail checkstyle configuration.
|
||||
- [ ] Documents are updated to aligning with code.
|
||||
- [ ] New starter must have sample folder contains sample code and corresponding readme file.
|
||||
- [ ] Code coverage for new codes >= 65%. Code coverage check is enabled with 65% bar.
|
||||
## Contribution
|
||||
Code contribution is welcome. To contribute to existing code or add a new starter, please make sure below check list is checked.
|
||||
- [ ] Build pass. Checkstyle and findbugs is enabled by default. Please check [checkstyle.xml](config/checkstyle.xml) to learn detailed checkstyle configuration.
|
||||
- [ ] Documents are updated to align with code.
|
||||
- [ ] New starter must have sample folder containing sample code and corresponding readme file.
|
||||
- [ ] Code coverage for new code >= 65%. Code coverage check is enabled with 65% bar.
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@
|
|||
|
||||
This repo is for Spring Boot Starters of Azure services. It helps Spring Boot developers to adopt Azure services.
|
||||
|
||||
### Prequisite
|
||||
### Prerequisites
|
||||
- JDK 1.8 and above
|
||||
- [Maven](http://maven.apache.org/) 3.0 and above
|
||||
|
||||
|
|
@ -28,7 +28,7 @@ Starter Name | Version
|
|||
|
||||
|
||||
### How to Build and Contribute
|
||||
Please follow [instruction here](./HowToContribute.md) to build from source or contribute.
|
||||
Please follow [instructions here](./HowToContribute.md) to build from source or contribute.
|
||||
|
||||
### Other articles
|
||||
You could check below articles to learn more on usage of specific starters.
|
||||
|
|
|
|||
|
|
@ -178,8 +178,8 @@
|
|||
</formats>
|
||||
<check>
|
||||
<haltOnFailure>true</haltOnFailure>
|
||||
<branchRate>60</branchRate>
|
||||
<totalBranchRate>60</totalBranchRate>
|
||||
<branchRate>65</branchRate>
|
||||
<totalBranchRate>65</totalBranchRate>
|
||||
</check>
|
||||
<instrumentation>
|
||||
<excludes>
|
||||
|
|
|
|||
|
|
@ -37,5 +37,5 @@ In `app.js`, make following changes. The client leverages Azure AD library for J
|
|||
* `mvn clean install`.
|
||||
* `cd azure-active-directory-spring-boot-sample`
|
||||
* `mvn spring-boot:run`
|
||||
* If running locally, browse to `http://localhost:8080` and click `Login` or `Todo List`, your brower will be redirected to `https://login.microsoftonline.com/` for authentication.
|
||||
* If running locally, browse to `http://localhost:8080` and click `Login` or `Todo List`, your browser will be redirected to `https://login.microsoftonline.com/` for authentication.
|
||||
* Upon successful login, `Todo List` will give you a default item and you can perform add, update or delete operation. The backend RESTful API will accept or deny your request based on authenticated user roles.
|
||||
|
|
@ -45,5 +45,5 @@ Caused by: java.lang.SecurityException: class "com.microsoft.azure.sample.User_A
|
|||
|
||||
### More details
|
||||
|
||||
Please refer to [this article](https://docs.microsoft.com/en-us/azure/cosmos-db/documentdb-java-spring-boot-starter-with-cosmos-db) for the toturial about how to use the Spring Boot Starter with Azure Cosmos DB DocumentDB API.
|
||||
Please refer to [this article](https://docs.microsoft.com/en-us/azure/cosmos-db/documentdb-java-spring-boot-starter-with-cosmos-db) for the tutorial about how to use the Spring Boot Starter with Azure Cosmos DB DocumentDB API.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# Azure Key Vault Secrets Spring Boot Starter Sample
|
||||
This sample illustrates how to use [Azure Key Vault Secrets Spring Boot Starter](../../azure-spring-boot-starters/azure-keyvault-secrets-spring-boot-starter/README.md).
|
||||
|
||||
In this sample, a secret named `spring-datasource-url` is stored into an Azure Key Vault, and a sample Spring application will use its value as a configuraiton property value.
|
||||
In this sample, a secret named `spring-datasource-url` is stored into an Azure Key Vault, and a sample Spring application will use its value as a configuration property value.
|
||||
|
||||
## Setup Azure Key Vault
|
||||
First, we need to store secret `spring-datasource-url` into Azure Key Vault.
|
||||
|
|
@ -26,7 +26,7 @@ az keyvault set-policy --name <your_keyvault_name> --secret-permission all --obj
|
|||
```
|
||||
Save the displayed Key Vault uri for later use.
|
||||
|
||||
- Set secret in Azure KeyVault by using Azure CLI or via Azure Portal.
|
||||
- Set secret in Azure Key Vault by using Azure CLI or via Azure Portal.
|
||||
You can use the following az cli commands:
|
||||
```bash
|
||||
az keyvault secret set --name spring-datasource-url --value jdbc:mysql://localhost:3306/moviedb --vault-name <your_keyvault_name>
|
||||
|
|
@ -44,12 +44,12 @@ If you are using Maven, add the following dependency.
|
|||
<dependency>
|
||||
<groupId>com.microsoft.azure</groupId>
|
||||
<artifactId>azure-keyvault-secrets-spring-boot-starter</artifactId>
|
||||
<version>0.1.9</version>
|
||||
<version>0.2.0</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
## Add the property setting
|
||||
Open `application.properties` file and add below properties to specify your Azure KeyVault url, Azure service principle client id and client key.
|
||||
Open `application.properties` file and add below properties to specify your Azure Key Vault url, Azure service principle client id and client key.
|
||||
|
||||
```
|
||||
azure.keyvault.uri=put-your-azure-keyvault-uri-here
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
## Overview
|
||||
This is a pre-release package that enables Spring Security integration with Azure Active Directory for authentication and integration scenarios via OpenID Connect/OAuth 2.0 protocols. Currently it supports the implicit authorization grant, making it ideal for enabling authenticaton and authorization for Single Page Application (SPA) web apps.
|
||||
This is a pre-release package that enables Spring Security integration with Azure Active Directory for authentication and integration scenarios via OpenID Connect/OAuth 2.0 protocols. Currently it supports the implicit authorization grant, making it ideal for enabling authentication and authorization for Single Page Application (SPA) web apps.
|
||||
|
||||
### Implementation summary
|
||||
This package provides a Spring Security filter to validate the Jwt token from Azure AD. The Jwt token is also used to acquire a On-Behalf-Of token for Azure AD Graph API so that authenticated user's membership information is available for authorization of access of API resources. Below is a diagram that shows the layers and typical flow for Single Page Application with Spring Boot web API backend that uses the filter for Authentication and Authorization.
|
||||
|
|
@ -19,7 +19,7 @@ If you are using Maven, add the following dependency.
|
|||
<dependency>
|
||||
<groupId>com.microsoft.azure</groupId>
|
||||
<artifactId>azure-active-directory-spring-boot-starter</artifactId>
|
||||
<version>0.1.9</version>
|
||||
<version>0.2.0</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -13,10 +13,10 @@
|
|||
There're 2 ways to map a field in domain class to `id` of Azure Cosmos DB document.
|
||||
- annotate a field in domain class with @Id, this field will be mapped to document `id` in Cosmos DB.
|
||||
- set name of this field to `id`, this field will be mapped to document `id` in Cosmos DB.
|
||||
[Note] if both way appplied,
|
||||
[Note] if both way applied,
|
||||
- Custom collection Name.
|
||||
By default, collection name will be class name of user domain class. To customize it, add annoataion `@Document(collection="myCustomCollectionName")` to your domain class, that's all.
|
||||
- Supports [Azure Cosmos DB partition](https://docs.microsoft.com/en-us/azure/cosmos-db/partition-data). To specify a field of your domain class to be partition key field, just annotate it with `@PartitionKey`. When you do CRUD operation, pls specify your partition value. For more sample on partition CRUD, pls refer to [test here](./test/java/com/microsoft/azure/spring/data/documentdb/repository/AddressRepositoryIT.java)
|
||||
By default, collection name will be class name of user domain class. To customize it, add annotation `@Document(collection="myCustomCollectionName")` to your domain class, that's all.
|
||||
- Supports [Azure Cosmos DB partition](https://docs.microsoft.com/en-us/azure/cosmos-db/partition-data). To specify a field of your domain class to be partition key field, just annotate it with `@PartitionKey`. When you do CRUD operation, please specify your partition value. For more sample on partition CRUD, please refer to [test here](./test/java/com/microsoft/azure/spring/data/documentdb/repository/AddressRepositoryIT.java)
|
||||
|
||||
## Sample Code
|
||||
Please refer to [sample project here](../../azure-spring-boot-samples/azure-documentdb-spring-boot-sample).
|
||||
|
|
@ -32,7 +32,7 @@ If you are using Maven, add the following dependency.
|
|||
<dependency>
|
||||
<groupId>com.microsoft.azure</groupId>
|
||||
<artifactId>azure-documentdb-spring-boot-starter</artifactId>
|
||||
<version>0.1.9</version>
|
||||
<version>0.2.0</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
|
|
@ -48,7 +48,7 @@ azure.documentdb.database=your-documentdb-databasename
|
|||
|
||||
Property `azure.documentdb.consistency-level` is also supported.
|
||||
|
||||
### Define en entity
|
||||
### Define an entity
|
||||
Define a simple entity as Document in DocumentDB.
|
||||
|
||||
```
|
||||
|
|
@ -130,6 +130,6 @@ Find more information about Azure Service Privacy Statement, please check [Micro
|
|||
|
||||
### Further info
|
||||
|
||||
Besides using Azure Cosmos DB DocumentDB API Spring boot starter, you can directly use Azure Cosmos DB DocumentDB API Spring Data package to more complex scenario, detail pls refer to [Spring Data for Azure Cosmos DB DocumentDB API](https://github.com/Microsoft/spring-data-documentdb).
|
||||
Besides using this Azure DocumentDB Spring Boot Starter, you can directly use Azure DocumentDB API Spring Data package for more complex scenarios. Please refer to [Spring Data for Azure Cosmos DB DocumentDB API](https://github.com/Microsoft/spring-data-documentdb) for more details.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
## Azure Key Vault Secrets Spring boot starter
|
||||
Azure Key Vault Secrets Spring boot starter is Spring starter for [Azure Key Vault Secrets](https://docs.microsoft.com/en-us/rest/api/keyvault/about-keys--secrets-and-certificates#BKMK_WorkingWithSecrets). With this starter, Azure Key Vault is added as one of Spring PropertySource, so secrets stored in Azure Key Vault could be used easily and conviniently accessed like other externalized configuration property, e.g. properties in files.
|
||||
Azure Key Vault Secrets Spring boot starter is Spring starter for [Azure Key Vault Secrets](https://docs.microsoft.com/en-us/rest/api/keyvault/about-keys--secrets-and-certificates#BKMK_WorkingWithSecrets). With this starter, Azure Key Vault is added as one of Spring PropertySource, so secrets stored in Azure Key Vault could be easily used and conveniently accessed like other externalized configuration property, e.g. properties in files.
|
||||
|
||||
## Sample Code
|
||||
Pls refer to [sample project here](../../azure-spring-boot-samples/azure-keyvault-secrets-spring-boot-sample).
|
||||
Please refer to [sample project here](../../azure-spring-boot-samples/azure-keyvault-secrets-spring-boot-sample).
|
||||
|
||||
## Quick Start
|
||||
|
||||
|
|
@ -15,7 +15,7 @@ If you are using Maven, add the following dependency.
|
|||
<dependency>
|
||||
<groupId>com.microsoft.azure</groupId>
|
||||
<artifactId>azure-keyvault-secrets-spring-boot-starter</artifactId>
|
||||
<version>0.1.9</version>
|
||||
<version>0.2.0</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ If you are using Maven, add the following dependency.
|
|||
<dependency>
|
||||
<groupId>com.microsoft.azure</groupId>
|
||||
<artifactId>azure-mediaservices-spring-boot-starter</artifactId>
|
||||
<version>0.1.9</version>
|
||||
<version>0.2.0</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ If you are using Maven, add the following dependency.
|
|||
<dependency>
|
||||
<groupId>com.microsoft.azure</groupId>
|
||||
<artifactId>azure-servicebus-spring-boot-starter</artifactId>
|
||||
<version>0.1.9</version>
|
||||
<version>0.2.0</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ If you are using Maven, add the following dependency.
|
|||
<dependency>
|
||||
<groupId>com.microsoft.azure</groupId>
|
||||
<artifactId>azure-storage-spring-boot-starter</artifactId>
|
||||
<version>0.1.9</version>
|
||||
<version>0.2.0</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -9,11 +9,11 @@ This package provides auto-configuration for below Azure Services:
|
|||
- Service Bus
|
||||
- Storage
|
||||
|
||||
Taking Service Bus for example, if you want to use this service in your application, add this dependency and Service Bus libaray module to your pom file. Or simply use the [Service Bus Starter](../azure-spring-boot-starters/azure-servicebus-spring-boot-starter).
|
||||
Taking Service Bus for example, if you want to use this service in your application, add this dependency and Service Bus library module to your pom file. Or simply use the [Service Bus Starter](../azure-spring-boot-starters/azure-servicebus-spring-boot-starter).
|
||||
|
||||
## Azure Cloud Foundry Service
|
||||
This module also provides the ability to automatically inject credentials from Cloud Foundry into your
|
||||
applications consuming Azure services. It does this by reading the VCAP_SERVICES environment
|
||||
variable and setting the appropriate properties on the azure auto-configuration projects.
|
||||
variable and setting the appropriate properties used by auto-configuration code.
|
||||
|
||||
For details, please see sample code in the [azure-cloud-foundry-service-sample](../azure-spring-boot-samples/azure-cloud-foundry-service-sample)
|
||||
Загрузка…
Ссылка в новой задаче