Spring Guides

https://spring.io/guides
Admin
Spring Guides provide practical, hands-on tutorials for using Spring projects and techniques,...
Tokens:233,580
Snippets:2,651
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Cloning the Guide's Repository

Source: https://spring.io/guides/gs/actuator-service

Clone the source repository for this guide to start with the provided code.

```bash
git clone https://github.com/spring-guides/gs-actuator-service.git
```

--------------------------------

### Start Neo4j Server

Source: https://spring.io/guides/gs/accessing-data-neo4j

Starts the Neo4j server with default settings after installation. Check the Neo4j logs for status updates.

```bash
neo4j start
```

--------------------------------

### Example HTTP GET Request

Source: https://spring.io/guides/gs/actuator-service

This is an example of an HTTP GET request to the 'hello-world' endpoint of the service.

```bash
Copy$ curl http://localhost:9000/hello-world
```

--------------------------------

### Gradle Project Setup

Source: https://spring.io/guides/gs/accessing-gemfire-data-rest

Example build.gradle for a Spring Boot project with Spring Data GemFire dependency.

```gradle
plugins {
    id 'org.springframework.boot' version '2.7.0'
    id 'io.spring.dependency-management' version '1.0.11.RELEASE'
    id 'io.freefair.lombok' version '6.3.0'
    id 'java'
}

apply plugin: 'eclipse'
apply plugin: 'idea'

group = "org.springframework"
version = "0.1.0"
sourceCompatibility = 1.8
targetCompatibility = 1.8

repositories {
    mavenCentral()
}

dependencies {

    implementation "org.springframework.boot:spring-boot-starter-data-rest"
    implementation "org.springframework.data:spring-data-geode"
    implementation "org.projectlombok:lombok"

    runtimeOnly "org.springframework.shell:spring-shell:1.2.0.RELEASE"

    testImplementation "org.springframework.boot:spring-boot-starter-test"

}

test {
    useJUnitPlatform()
}

bootJar {
    baseName = 'gs-accessing-gemfire-data-rest'
    version =  '0.1.0'
}
```

--------------------------------

### Maven Project Setup

Source: https://spring.io/guides/gs/accessing-gemfire-data-rest

Example pom.xml for a Spring Boot project with Spring Data GemFire dependency.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
		 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
		 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">

	<modelVersion>4.0.0</modelVersion>

	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.7.0</version>
	</parent>

	<groupId>org.springframework</groupId>
	<artifactId>gs-accessing-gemfire-data-rest</artifactId>
	<version>0.1.0</version>

	<properties>
		<spring-shell.version>1.2.0.RELEASE</spring-shell.version>
	</properties>

	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-data-rest</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.data</groupId>
			<artifactId>spring-data-geode</artifactId>
		</dependency>
		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.shell</groupId>
			<artifactId>spring-shell</artifactId>
			<version>${spring-shell.version}</version>
			<scope>runtime</scope>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
			<exclusions>
				<exclusion>
					<groupId>org.junit.vintage</groupId>
					<artifactId>junit-vintage-engine</artifactId>
				</exclusion>
			</exclusions>
		</dependency>
	</dependencies>

	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>

</project>
```

--------------------------------

### Spring Boot Application Startup Output

Source: https://spring.io/guides/gs/spring-boot

Example output observed after successfully starting a Spring Boot application, showing initialized beans.

```text
Let's inspect the beans provided by Spring Boot:
application
applicationAvailability
applicationTaskExecutor
applicationTaskExecutorAsyncConfigurer
availabilityProbesHealthEndpointGroupsPostProcessor
basicErrorController
beanNameHandlerMapping
beanNameViewResolver
...
```

--------------------------------

### Clone a Spring Guide Project

Source: https://spring.io/guides/gs/guides-with-vscode

Use this command to clone the REST Service guide project from GitHub to your local machine.

```bash
git clone https://github.com/spring-guides/gs-rest-service.git
```

--------------------------------

### Maven Installation Details

Source: https://spring.io/guides/gs/maven

This output shows the details of a Maven installation, including the version, home directory, Java version, and operating system information.

```text
Apache Maven 3.3.9 (bb52d8502b132ec0a5a3f4c09453c07478323dc5; 2015-11-10T16:41:47+00:00)
Maven home: /home/dsyer/Programs/apache-maven
Java version: 1.8.0_152, vendor: Azul Systems, Inc.
Java home: /home/dsyer/.sdkman/candidates/java/8u152-zulu/jre
Default locale: en_GB, platform encoding: UTF-8
OS name: "linux", version: "4.15.0-36-generic", arch: "amd64", family: "unix"
```

--------------------------------

### Greeting JSON Response Example

Source: https://spring.io/guides/gs/rest-service-cors

Example JSON structure for a greeting resource representation. This is the expected output format for a GET request to /greeting.

```json
{
    "id": 1,
    "content": "Hello, World!"
}
```

--------------------------------

### Application Output Example

Source: https://spring.io/guides/gs/accessing-data-jpa

Shows the expected output when the application is run, including fetched customer data.

```text
Customers found with findAll():
Customer[id=1, firstName='Jack', lastName='Bauer']
Customer[id=2, firstName='Chloe', lastName='O'Brian']
Customer[id=3, firstName='Kim', lastName='Bauer']
Customer[id=4, firstName='David', lastName='Palmer']
Customer[id=5, firstName='Michelle', lastName='Dessler']

Customer found with findById(1L):
Customer[id=1, firstName='Jack', lastName='Bauer']

Customer found with findByLastName('Bauer'):
Customer[id=1, firstName='Jack', lastName='Bauer']
Customer[id=3, firstName='Kim', lastName='Bauer']
```

--------------------------------

### Gradle Welcome Message

Source: https://spring.io/guides/gs/gradle

This output confirms a successful Gradle installation and provides basic usage commands.

```bash
gradle
```

```text
:help

Welcome to Gradle 6.0.1.

To run a build, run gradle <task> ...

To see a list of available tasks, run gradle tasks

To see a list of command-line options, run gradle --help

To see more detail about a task, run gradle help --task <task>

For troubleshooting, visit https://help.gradle.org

Deprecated Gradle features were used in this build, making it incompatible with Gradle 7.0.
Use '--warning-mode all' to show the individual deprecation warnings.
See https://docs.gradle.org/6.0.1/userguide/command_line_interface.html#sec:command_line_warnings

BUILD SUCCESSFUL in 455ms
1 actionable task: 1 executed
```

--------------------------------

### Clone a Spring REST Service Guide

Source: https://spring.io/guides/gs/intellij-idea

Use Git to clone the Spring REST Service guide repository to your local machine. This provides the initial code for the guide.

```bash
Copy$ git clone https://github.com/spring-guides/gs-rest-service.git
```

--------------------------------

### Install Maven Project to Local Repository

Source: https://spring.io/guides/gs/maven

The 'mvn install' goal compiles, tests, and packages the project, then copies the artifact into the local Maven dependency repository.

```bash
mvn install
```

--------------------------------

### Retrieve All Users using curl

Source: https://spring.io/guides/gs/accessing-data-mysql

This command-line example shows how to retrieve all users from the application's database using an HTTP GET request to the /demo/all endpoint.

```shell
$ curl http://localhost:8080/demo/all
```

--------------------------------

### Start RabbitMQ with Docker

Source: https://spring.io/guides/gs/spring-cloud-stream

Starts a RabbitMQ instance using Docker for local development and testing. This command exposes the management UI and AMQP ports.

```bash
docker run -d --hostname my-rabbit --name some-rabbit -p 15672:15672 -p 5672:5672 rabbitmq:3-management
```

--------------------------------

### Install Neo4j with Homebrew

Source: https://spring.io/guides/gs/accessing-data-neo4j

Installs the Neo4j server on macOS using Homebrew. Ensure you have Homebrew installed before running this command.

```bash
brew install neo4j
```

--------------------------------

### Application Output Example

Source: https://spring.io/guides/gs/accessing-data-r2dbc

Example output when running the Spring Data R2DBC application, showing fetched customer data.

```text
== Customers found with findAll():
Customer[id=1, firstName='Jack', lastName='Bauer']
Customer[id=2, firstName='Chloe', lastName='O'Brian']
Customer[id=3, firstName='Kim', lastName='Bauer']
Customer[id=4, firstName='David', lastName='Palmer']
Customer[id=5, firstName='Michelle', lastName='Dessler']

== Customer found with findOne(1L):
Customer[id=1, firstName='Jack', lastName='Bauer']

== Customer found with findByLastName('Bauer'):
Customer[id=1, firstName='Jack', lastName='Bauer']
Customer[id=3, firstName='Kim', lastName='Bauer']
```

--------------------------------

### Example JSON Response

Source: https://spring.io/guides/gs/actuator-service

This is the expected JSON response from the 'hello-world' endpoint.

```json
Copy{"id":1,"content":"Hello, World!"}
```

--------------------------------

### Application Output Example

Source: https://spring.io/guides/gs/accessing-data-neo4j

This output shows the state of relationships in the Neo4j database before and after establishing connections, and demonstrates a reverse lookup.

```text
Before linking up with Neo4j...
	Greg referred => []
	Roy referred => []
	Craig referred => []

Lookup each person by name...
	Greg referred => [Roy, Craig]
	Roy referred => [Craig]
	Craig referred => []

The following referred Craig...
	Greg
	Roy
```

--------------------------------

### Example GraphQL Response

Source: https://spring.io/guides/gs/graphql-server

This is an example JSON response from a GraphQL server for the bookDetails query, showing the requested book's information.

```json
{
  "bookById": {
    "id":"book-1",
    "name":"Effective Java",
    "pageCount":416,
    "author": {
      "firstName":"Joshua",
      "lastName":"Bloch"
    }
  }
}
```

--------------------------------

### Batch Job Output Example

Source: https://spring.io/guides/gs/batch-processing

Example output showing the conversion of data during batch processing and confirmation of data found in the database.

```text
Converting (Person[firstName=Jill, lastName=Doe]) into (Person[firstName=JILL, lastName=DOE])
Converting (Person[firstName=Joe, lastName=Doe]) into (Person[firstName=JOE, lastName=DOE])
Converting (Person[firstName=Justin, lastName=Doe]) into (Person[firstName=JUSTIN, lastName=DOE])
Converting (Person[firstName=Jane,อด Doe]) into (Person[firstName=JANE, lastName=DOE])
Converting (Person[firstName=John, lastName=Doe]) into (Person[firstName=JOHN, lastName=DOE])
Found <Person[firstName=JILL, lastName=DOE]> in the database.
Found <Person[firstName=JOE, lastName=DOE]> in the database.
Found <Person[firstName=JUSTIN, lastName=DOE]> in the database.
Found <Person[firstName=JANE, lastName=DOE]> in the database.
Found <Person[firstName=JOHN, lastName=DOE]> in the database.
```

--------------------------------

### Sample Application Output

Source: https://spring.io/guides/gs/consuming-rest

Example output from the running Spring Boot application, showing a fetched quotation from the REST service.

```text
2019-08-22 14:06:46.506  INFO 42940 --- [           main] c.e.c.ConsumingRestApplication           : Quote{type='success', value=Value{id=1, quote='Working with Spring Boot is like pair-programming with the Spring developers.'}}
```

--------------------------------

### Configure R2DBC ConnectionFactoryInitializer

Source: https://spring.io/guides/tutorials/spring-webflux-kotlin-rsocket

Set up a `ConnectionFactoryInitializer` to automatically initialize the database schema using a `schema.sql` file when the application starts.

```kotlin
@Configuration
class Config {

    @Bean
    fun initializer(connectionFactory: ConnectionFactory): ConnectionFactoryInitializer {
        val initializer = ConnectionFactoryInitializer()
        initializer.setConnectionFactory(connectionFactory)
        val populator = CompositeDatabasePopulator()
        populator.addPopulators(ResourceDatabasePopulator(ClassPathResource("./sql/schema.sql")))
        initializer.setDatabasePopulator(populator)
        return initializer
    }
}
```

--------------------------------

### Run Redis Locally

Source: https://spring.io/guides/tutorials/spring-security-and-angular-js

Start a Redis instance for session storage using Docker. This is a prerequisite for shared session authentication.

```bash
docker run -p 6379:6379 redis
```

--------------------------------

### Initialize Git Repository and Add Files

Source: https://spring.io/guides/gs/centralized-configuration

These shell commands demonstrate how to initialize a Git repository in a directory and list its contents, including configuration files.

```shell
$ cd ~/Desktop/config
$ find .
./.git
...
./application.yml
```

--------------------------------

### Run Native Executable

Source: https://spring.io/guides/gs/spring-data-reactive-redis

Execute the compiled native image for a near-instantaneous startup time.

```bash
target/demo
```

--------------------------------

### Greeting Request with Name Parameter

Source: https://spring.io/guides/gs/rest-service

Example of a GET request to the greeting endpoint with a 'name' query parameter.

```http
http://localhost:8080/greeting?name=User
```

--------------------------------

### Running Second Say Hello Instance with Gradle

Source: https://spring.io/guides/gs/spring-cloud-loadbalancer

Starts a second instance of the 'Say Hello' service on a different port using Gradle, setting the SERVER_PORT environment variable.

```bash
Copyexport SERVER_PORT=9092
./gradlew bootRun
```

--------------------------------

### Running Say Hello Service with Gradle

Source: https://spring.io/guides/gs/spring-cloud-loadbalancer

Command to run the 'Say Hello' service using Gradle.

```bash
Copy$ ./gradlew bootRun
```

--------------------------------

### Application Output Example

Source: https://spring.io/guides/gs/accessing-data-mongodb

This output shows the results of database operations invoked automatically when the Spring Boot application starts, due to implementing CommandLineRunner.

```text
Customers found with findAll():
-------------------------------
Customer[id=51df1b0a3004cb49c50210f8, firstName='Alice', lastName='Smith']
Customer[id=51df1b0a3004cb49c50210f9, firstName='Bob', lastName='Smith']

Customer found with findByFirstName('Alice'):
--------------------------------
Customer[id=51df1b0a3004cb49c50210f8, firstName='Alice', lastName='Smith']
Customers found with findByLastName('Smith'):
--------------------------------
Customer[id=51df1b0a3004cb49c50210f8, firstName='Alice', lastName='Smith']
Customer[id=51df1b0a3004cb49c50210f9, firstName='Bob', lastName='Smith']
```

--------------------------------

### Navigating to the Initial Project Directory

Source: https://spring.io/guides/gs/actuator-service

Change directory into the 'initial' folder of the cloned repository.

```bash
cd gs-actuator-service/initial
```

--------------------------------

### Client Request to Gateway

Source: https://spring.io/guides/tutorials/spring-security-and-angular-js

This is an example of an HTTP GET request from a client to the API Gateway. It includes headers like X-Requested-With and X-XSRF-TOKEN, and cookies for session and CSRF protection.

```http
GET /resource/ HTTP/1.1
Host: localhost:8080
Accept: application/json, text/plain, */*
X-Requested-With: XMLHttpRequest
X-XSRF-TOKEN: 542c7005-309c-4f50-8a1d-d6c74afe8260
Cookie: SESSION=c18846b5-f805-4679-9820-cd13bd83be67; XSRF-TOKEN=542c7005-309c-4f50-8a1d-d6c74afe8260

Response:
Content-Type: application/json;charset=UTF-8
Status: 200
```

--------------------------------

### REST API Example: Fetching Track Data

Source: https://spring.io/guides/topicals/observing-graphql-in-action

Shows how to fetch individual track details using a REST API endpoint. This is typically done after retrieving album information to get specific track data.

```json
{
  "id": 1265,
  "title": "Spring music",
  "number": 1,
  "duration": 128,
  "artist": {
    "id": 339,
    "name": "The Spring team"
  },
  "album": {
    "id": 339,
    "name": "Greatest hits",
    "trackCount": "14"
  },
  "lyrics": "https://example.com/lyrics/the-spring-team/spring-music.txt"
}
```

--------------------------------

### Check Maven Installation

Source: https://spring.io/guides/gs/maven

Verify that Maven is installed correctly by checking its version. This command should display information about your Maven installation.

```bash
mvn -v
```

--------------------------------

### Running Second Say Hello Instance with Maven

Source: https://spring.io/guides/gs/spring-cloud-loadbalancer

Starts a second instance of the 'Say Hello' service on a different port using Maven, setting the SERVER_PORT environment variable.

```bash
Copyexport SERVER_PORT=9999
mvn spring-boot:run
```

--------------------------------

### JSON Greeting Payload Example

Source: https://spring.io/guides/gs/messaging-stomp-websocket

Example of a JSON payload for a greeting message.

```json
{
    "content": "Hello, Fred!"
}
```

--------------------------------

### Running Say Hello Service with Maven

Source: https://spring.io/guides/gs/spring-cloud-loadbalancer

Command to run the 'Say Hello' service using Maven.

```bash
Copy$ mvn spring-boot:run
```

--------------------------------

### Example JSON Response

Source: https://spring.io/guides/gs/consuming-rest

This is an example of the JSON document returned by the REST API.

```json
{
   type: "success",
   value: {
      id: 10,
      quote: "Really loving Spring Boot, makes stand alone Spring apps easy."
   }
}
```

--------------------------------

### Build and Run Spring Boot App with Maven Wrapper

Source: https://spring.io/guides/tutorials/spring-boot-oauth2

Demonstrates how to package and run a Spring Boot application using the Maven wrapper. Ensure you are in the application's directory.

```bash
cd simple
../mvnw package
java -jar target/*.jar
```

--------------------------------

### Install Curl in Alpine Container

Source: https://spring.io/guides/gs/spring-data-reactive-redis

Install the curl utility within the Alpine Linux container.

```bash
apk add curl
```

--------------------------------

### Start Docker Compose

Source: https://spring.io/guides/gs/accessing-data-mysql

Start the Docker containers defined in the docker-compose.yaml file in detached mode.

```bash
docker compose up -d
```

--------------------------------

### Create application.properties using command line

Source: https://spring.io/guides/topicals/spring-on-kubernetes

An alternative method to create the application.properties file directly from the command line using a heredoc.

```bash
cat <<EOF >./application.properties
server.shutdown=graceful
management.endpoints.web.exposure.include=*
EOF
```

--------------------------------

### JSON Message Payload Example

Source: https://spring.io/guides/gs/messaging-stomp-websocket

Example of a JSON message payload containing a user's name.

```json
{
    "name": "Fred"
}
```

--------------------------------

### Blog Data Initialization (Kotlin)

Source: https://spring.io/guides/tutorials/spring-boot-kotlin

Configures the database with initial user and article data using Spring Data JDBC. Demonstrates the use of AggregateReference.to() for foreign key relationships.

```kotlin
Copy@Configuration
class BlogConfiguration {

    @Bean
    fun databaseInitializer(
        userRepository: UserRepository,
        articleRepository: ArticleRepository
    ) = ApplicationRunner {
        val johnDoe = userRepository.save(User("johnDoe", "John", "Doe"))
        articleRepository.save(
            Article(
                title = "Lorem",
                headline = "Lorem",
                content = "dolor sit amet",
                author = AggregateReference.to(johnDoe.id!!)
            )
        )

        articleRepository.save(
            Article(
                title = "Ipsum",
                headline = "Ipsum",
                content = "dolor sit amet",
                author = AggregateReference.to(johnDoe.id)
            )
        )
    }
}
```

--------------------------------

### Install HashiCorp Vault

Source: https://spring.io/guides/gs/accessing-vault

Commands to install Vault using Homebrew on macOS. For other systems, refer to official instructions.

```bash
$ brew tap hashicorp/tap
$ brew install hashicorp/tap/vault
```

--------------------------------

### Build and Run Spring Boot Application

Source: https://spring.io/guides/gs/actuator-service

Build the application using Gradle and run the JAR file. The service will start on the configured server port.

```bash
./gradlew clean build && java -jar build/libs/gs-actuator-service-0.0.1-SNAPSHOT.jar
```

--------------------------------

### Build and Run Executable JAR

Source: https://spring.io/guides/gs/spring-data-reactive-redis

Compile the application into an executable JAR file and then run it.

```bash
./mvnw clean package
java -jar target/demo-0.0.1-SNAPSHOT.jar
```

--------------------------------

### Clone and Build Spring Boot App Locally

Source: https://spring.io/guides/gs/spring-boot-for-azure

Clone the sample project, build the JAR file using Maven, and run the application locally to test it before deploying to Azure.

```bash
mkdir SpringBoot
cd SpringBoot
git clone https://github.com/spring-guides/gs-spring-boot-for-azure
cd gs-spring-boot-for-azure/complete
./mvnw clean package
./mvnw spring-boot:run
```

--------------------------------

### HTTP Authorization Header Example

Source: https://spring.io/guides/tutorials/spring-security-and-angular-js

This is an example of the Authorization header sent by the browser for Basic authentication. It includes the encoded username and password.

```text
Authorization: Basic dXNlcjpwYXNzd29yZA==
```

--------------------------------

### Initial Gradle Build File

Source: https://spring.io/guides/gs/messaging-gcp-pubsub

Sets up a basic Gradle build script for a Spring Boot application, including necessary plugins and dependencies.

```gradle
plugins {
    id 'java'
    id 'org.springframework.boot' version '3.5.14'
    id 'io.spring.dependency-management' version '1.1.7'
}

repositories {
    mavenCentral()
}

java {
    sourceCompatibility = 17
    targetCompatibility = 17
}

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-web'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
}
```

--------------------------------

### Say Hello Application Configuration

Source: https://spring.io/guides/gs/spring-cloud-loadbalancer

YAML configuration for the 'Say Hello' service, setting the application name and server port.

```yaml
spring:
  application:
    name: say-hello

server:
  port: 8090
```

--------------------------------

### List Application JAR File

Source: https://spring.io/guides/gs/spring-boot-kubernetes

Display the generated JAR file from the build output. This confirms the application has been successfully packaged.

```bash
ls -l target/*.jar
```

--------------------------------

### Run Spring Boot Application with Installed Maven

Source: https://spring.io/guides/tutorials/rest

Command to run the Spring Boot application using a locally installed Maven. This is an alternative to using the Maven wrapper.

```bash
$ mvn clean spring-boot:run
```

--------------------------------

### Update Test Setup with Markdown Messages

Source: https://spring.io/guides/tutorials/spring-webflux-kotlin-rsocket

Modifies the `@BeforeEach` setup in tests to include messages with `ContentType.MARKDOWN`. This ensures that markdown content is correctly represented in the test data.

```kotlin
@BeforeEach
fun setUp() {
    //...
            Message(
                    "*testMessage*",
                    ContentType.PLAIN,
                    twoSecondBeforeNow,
                    "test",
                    "http://test.com"
            ),
            Message(
                    "**testMessage2**",
                    ContentType.MARKDOWN,
                    secondBeforeNow,
                    "test1",
                    "http://test.com"
            ),
            Message(
                    "`testMessage3`",
                    ContentType.MARKDOWN,
                    now,
                    "test2",
                    "http://test.com"
            )
   //...
}
```

--------------------------------

### Sample Terminal Output for Maven Configuration

Source: https://spring.io/guides/gs/spring-boot-for-azure

This is a sample of the terminal output when running the Maven configuration command, showing the interactive prompts and final summary of configurations.

```bash
~@Azure:~/gs-spring-boot/complete$ ./mvnw com.microsoft.azure:azure-spring-apps-maven-plugin:1.14.0:config -DadvancedOptions
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building boot-for-azure 0.0.1-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- azure-spring-apps-maven-plugin:1.14.0:config (default-cli) @ demo ---
...
Available subscription:
 1. xxx
...
Select subscription [1-105] (20):
...
Available Azure Spring Apps:
 1. xxx
...
Select Azure Spring Apps for deployment: [1-28] (1): 1
[INFO] Using Azure Spring Apps: xxx
Input the app name (demo):
Expose public access for this app boot-for-azure? (y/N):y
Summary of properties:
Subscription id   : xxx
Resource group name : xxx
Azure Spring Apps name : xxx
App name          : demo
Public access     : yes
Instance count    : 1
CPU count         : 1
Memory size(GB)   : 1
Runtime Java version : Java 17
Confirm to save all the above configurations (Y/n):Y

```

--------------------------------

### Example GraphQL Query

Source: https://spring.io/guides/gs/graphql-server

This is an example GraphQL request to retrieve book details by ID, including the book's ID, name, page count, and author's first and last name.

```graphql
query bookDetails {
  bookById(id: "book-1") {
    id
    name
    pageCount
    author {
      firstName
      lastName
    }
  }
}
```

--------------------------------

### Example Gateway Response

Source: https://spring.io/guides/gs/gateway

An example response received after testing the gateway with the cURL command. It shows the request arguments, headers (including the added 'Hello: World' header), origin IP, and the target URL.

```json
{
  "args": {},
  "headers": {
    "Accept": "*/*",
    "Connection": "close",
    "Forwarded": "proto=http;host=\"localhost:8080\";for=\"0:0:0:0:0:0:0:1:56207\"",
    "Hello": "World",
    "Host": "httpbin.org",
    "User-Agent": "curl/7.54.0",
    "X-Forwarded-Host": "localhost:8080"
  },
  "origin": "0:0:0:0:0:0:0:1, 73.68.251.70",
  "url": "http://httpbin.org/get"
}
```

--------------------------------

### Build and Run the Service

Source: https://spring.io/guides/gs/actuator-service

Command to build the service using Gradle and run the generated JAR file.

```bash
$ ./gradlew clean build && java -jar build/libs/gs-actuator-service-0.0.1-SNAPSHOT.jar
```

--------------------------------

### Application Output Example

Source: https://spring.io/guides/gs/messaging-rabbitmq

This output shows the successful sending and receiving of a message when the application runs. It confirms that the message 'Hello from RabbitMQ!' was processed.

```text
Sending message...
Received <Hello from RabbitMQ!>
```

--------------------------------

### GET /employees

Source: https://spring.io/guides/tutorials/rest

Retrieves a list of all employees.

```APIDOC
## GET /employees

### Description
Retrieves a list of all employees.

### Method
GET

### Endpoint
/employees

### Response
#### Success Response (200)
- **List** of Employee objects.

#### Response Example
{
  "example": "[{"id":1,"name":"Bilbo Baggins","role":"burglar"},{"id":2,"name":"Frodo Baggins","role":"thief"}]"
}
```

--------------------------------

### Get All People

Source: https://spring.io/guides/gs/accessing-gemfire-data-rest

Retrieves a collection of all 'Person' resources.

```APIDOC
## GET /people

### Description
Retrieves a collection of all 'Person' resources.

### Method
GET

### Endpoint
/people

### Response
#### Success Response (200)
- **_links** (object) - Contains links to other resources.
  - **search** (object) - Link to the search resource.
    - **href** (string) - The URL for the search resource.
- **_embedded** (object) - Contains the embedded resources.
  - **persons** (array) - An array of Person objects.
    - **firstName** (string) - The first name of the person.
    - **lastName** (string) - The last name of the person.
    - **_links** (object) - Links related to the person.
      - **self** (object) - Link to the individual person resource.
        - **href** (string) - The URL for the person resource.

### Response Example
```json
{
  "_links" : {
    "search" : {
      "href" : "http://localhost:8080/people/search"
    }
  },
  "_embedded" : {
    "persons" : [ {
      "firstName" : "Frodo",
      "lastName" : "Baggins",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/people/1"
        }
      }
    } ]
  }
}
```
```

--------------------------------

### GET /employees/{id}

Source: https://spring.io/guides/tutorials/rest

Retrieves a single employee by their ID.

```APIDOC
## GET /employees/{id}

### Description
Retrieves a single employee by their ID.

### Method
GET

### Endpoint
/employees/{id}

### Parameters
#### Path Parameters
- **id** (Long) - Required - The ID of the employee to retrieve.

### Response
#### Success Response (200)
- **Employee** object corresponding to the provided ID.

#### Error Response
- **404 Not Found**: If an employee with the specified ID is not found.

### Response Example
{
  "example": "{\"id\":1,\"name\":\"Bilbo Baggins\",\"role\":\"burglar\"}"
}
```

--------------------------------

### Spring Boot Application Startup Output with Wavefront Provisioning

Source: https://spring.io/guides/gs/tanzu-observability

This output indicates that a Wavefront account has been provisioned, an API token generated, and provides a one-time use link to access your Wavefront dashboard.

```log
INFO 58371 --- [           main] o.s.b.a.e.web.EndpointLinksResolver      : Exposing 1 endpoint(s) beneath base path '/actuator'
INFO 58371 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8080 (http) with context path ''
INFO 58371 --- [           main] hello.DemoApplication                    : Started DemoApplication in 1.705 seconds (process running for 2.038)

A Wavefront account has been provisioned successfully and the API token has been saved to disk.

To share this account, make sure the following is added to your configuration:

    management.wavefront.api-token=ee1f454b-abcd-efgh-1234-bb449f6a25ed
    management.wavefront.uri=https://wavefront.surf

Connect to your Wavefront dashboard using this one-time use link:
https://wavefront.surf/us/AtoKen
```

--------------------------------

### Add a User using curl

Source: https://spring.io/guides/gs/accessing-data-mysql

This command-line example demonstrates how to add a new user to the application's database using an HTTP POST request. It specifies the name and email as request parameters.

```shell
$ curl http://localhost:8080/demo/add -d name=First -d email=someemail@someemailprovider.com
```

--------------------------------

### Completed build.gradle File

Source: https://spring.io/guides/gs/gradle

This is the complete build.gradle file for the guide, incorporating the necessary configurations for building and running a Java project with Gradle.

```gradle
link:complete/build.gradle[role=include]
```

--------------------------------

### Get Person by ID

Source: https://spring.io/guides/gs/accessing-data-rest

Retrieves a specific person record by their ID.

```APIDOC
## GET /people/{id}

### Description
Retrieves a specific person record by their ID.

### Method
GET

### Endpoint
/people/{id}

### Path Parameters
- **id** (integer) - Required - The unique identifier of the person.

### Response
#### Success Response (200)
- **_links** (object) - Links related to the person.
- **firstName** (string) - The first name of the person.
- **lastName** (string) - The last name of the person.

### Response Example
{
  "_links": {
    "self": {
      "href": "http://localhost:8080/people/1"
    },
    "person": {
      "href": "http://localhost:8080/people/1"
    }
  },
  "firstName": "Frodo",
  "lastName": "Baggins"
}
```

--------------------------------

### Example JSON Response

Source: https://spring.io/guides/gs/rest-hateoas

A basic JSON representation of a greeting, including a self-link.

```json
{
  "content":"Hello, World!",
  "_links":{
    "self":{
      "href":"http://localhost:8080/greeting?name=World"
    }
  }
}
```
Tokens:
Raw