Skip to content

Commit

Permalink
upgrade docs
Browse files Browse the repository at this point in the history
  • Loading branch information
DanielLiu1123 committed Jul 3, 2024
1 parent 6c75b19 commit 964a185
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 23 deletions.
19 changes: 3 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# HttpExchange Spring Boot Starter
# HttpExchange Spring Boot Starter [![Build](https://img.shields.io/github/actions/workflow/status/DanielLiu1123/httpexchange-spring-boot-starter/build.yml?branch=main)](https://github.com/DanielLiu1123/httpexchange-spring-boot-starter/actions) [![Maven Central](https://img.shields.io/maven-central/v/io.github.danielliu1123/httpexchange-spring-boot-starter)](https://search.maven.org/artifact/io.github.danielliu1123/httpexchange-spring-boot-starter) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[![Build](https://img.shields.io/github/actions/workflow/status/DanielLiu1123/httpexchange-spring-boot-starter/build.yml?branch=main)](https://github.com/DanielLiu1123/httpexchange-spring-boot-starter/actions)
[![Maven Central](https://img.shields.io/maven-central/v/io.github.danielliu1123/httpexchange-spring-boot-starter)](https://search.maven.org/artifact/io.github.danielliu1123/httpexchange-spring-boot-starter)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[Documentation](https://danielliu1123.github.io/httpexchange-spring-boot-starter/)

Spring 6 now directly supports creating HTTP clients with the [`@HttpExchange`](https://docs.spring.io/spring-framework/reference/integration/rest-clients.html#rest-http-interface) annotation.
This means you can use Spring instead of needing [Spring Cloud OpenFeign](https://github.com/spring-cloud/spring-cloud-openfeign).
Expand All @@ -19,7 +17,7 @@ The main goals of this project:
- Add dependency:

```groovy
implementation("io.github.danielliu1123:httpexchange-spring-boot-starter:3.2.5")
implementation("io.github.danielliu1123:httpexchange-spring-boot-starter:3.3.0")
```

- Write a classic Spring Boot application:
Expand All @@ -44,17 +42,6 @@ The main goals of this project:
}
}
```

## Documentation

Go to [Documentation](https://danielliu1123.github.io/httpexchange-spring-boot-starter/) to view the full documentation.

## Version Compatibility

| Spring Boot | httpexchange-spring-boot-starter |
|-------------|----------------------------------|
| 3.2.x | 3.2.5 |
| 3.1.x | 3.1.8 |

## Code of Conduct

Expand Down
4 changes: 2 additions & 2 deletions gradle.properties
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
group=io.github.danielliu1123
version=3.3.0-SNAPSHOT
version=3.3.1-SNAPSHOT

springBootVersion=3.3.0
springBootVersion=3.3.1
# https://docs.spring.io/spring-cloud-release/reference/index.html
# https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-dependencies
#springCloudVersion=2023.0.2
Expand Down
4 changes: 2 additions & 2 deletions website/docs/01-intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -81,15 +81,15 @@ The main goals of this project:
<Tabs>
<TabItem value="gradle" label="Gradle">
```groovy
implementation("io.github.danielliu1123:httpexchange-spring-boot-starter:3.2.5")
implementation("io.github.danielliu1123:httpexchange-spring-boot-starter:3.3.0")
```
</TabItem>
<TabItem value="maven" label="Maven">
```xml
<dependency>
<groupId>io.github.danielliu1123</groupId>
<artifactId>httpexchange-spring-boot-starter</artifactId>
<version>3.2.5</version>
<version>3.3.0</version>
</dependency>
```
</TabItem>
Expand Down
4 changes: 2 additions & 2 deletions website/docs/10-core/20-generate-server-implementation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Generate default implementation for server, you can use the base implementation
<Tabs>
<TabItem value="gradle" label="Gradle">
```groovy
annotationProcessor("io.github.danielliu1123:httpexchange-processor:3.2.5")
annotationProcessor("io.github.danielliu1123:httpexchange-processor:3.3.0")
```
</TabItem>
<TabItem value="maven" label="Maven">
Expand All @@ -27,7 +27,7 @@ Generate default implementation for server, you can use the base implementation
<path>
<groupId>io.github.danielliu1123</groupId>
<artifactId>httpexchange-processor</artifactId>
<version>3.2.5</version>
<version>3.3.0</version>
</path>
</annotationProcessorPaths>
</configuration>
Expand Down
2 changes: 1 addition & 1 deletion website/docs/40-configuration-properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ This page was generated by [spring-configuration-property-documenter](https://gi
|---|----|-----------|-------------|-----------|
| enabled| java.lang.Boolean| Whether to enable refresh exchange clients, default \{@code false}. &lt;p&gt; This feature needs \{@code spring-cloud-context} dependency in the classpath. &lt;p color&#x3D;&quot;orange&quot;&gt; NOTE: This feature is not supported by native image. @see &lt;a href&#x3D;&quot;https://github.com/spring-cloud/spring-cloud-release/wiki/AOT-transformations-and-native-image-support#refresh-scope&quot;&gt;Refresh Scope&lt;/a&gt;| false| |

This is a generated file, generated at: **2024-07-03T19:52:43.989145**
This is a generated file, generated at: **2024-07-04T00:44:51.408096**
1 change: 1 addition & 0 deletions website/docs/50-version.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,6 @@ sidebar_position: 50

| Spring Boot | httpexchange-spring-boot-starter |
|-------------|----------------------------------|
| 3.3.x | 3.3.0 |
| 3.2.x | 3.2.5 |
| 3.1.x | 3.1.8 |

0 comments on commit 964a185

Please sign in to comment.