From 964a185099099f712150267e07f5b7ea0a4ed4fb Mon Sep 17 00:00:00 2001 From: Freeman Liu Date: Thu, 4 Jul 2024 00:42:52 +0800 Subject: [PATCH] upgrade docs --- README.md | 19 +++---------------- gradle.properties | 4 ++-- website/docs/01-intro.mdx | 4 ++-- .../20-generate-server-implementation.mdx | 4 ++-- website/docs/40-configuration-properties.md | 2 +- website/docs/50-version.mdx | 1 + 6 files changed, 11 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 842657a..8e2fa92 100644 --- a/README.md +++ b/README.md @@ -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). @@ -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: @@ -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 diff --git a/gradle.properties b/gradle.properties index e77c6d6..28f6c82 100644 --- a/gradle.properties +++ b/gradle.properties @@ -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 diff --git a/website/docs/01-intro.mdx b/website/docs/01-intro.mdx index a5483f0..dbe1567 100644 --- a/website/docs/01-intro.mdx +++ b/website/docs/01-intro.mdx @@ -81,7 +81,7 @@ The main goals of this project: ```groovy - implementation("io.github.danielliu1123:httpexchange-spring-boot-starter:3.2.5") + implementation("io.github.danielliu1123:httpexchange-spring-boot-starter:3.3.0") ``` @@ -89,7 +89,7 @@ The main goals of this project: io.github.danielliu1123 httpexchange-spring-boot-starter - 3.2.5 + 3.3.0 ``` diff --git a/website/docs/10-core/20-generate-server-implementation.mdx b/website/docs/10-core/20-generate-server-implementation.mdx index 2a6303a..804d6c1 100644 --- a/website/docs/10-core/20-generate-server-implementation.mdx +++ b/website/docs/10-core/20-generate-server-implementation.mdx @@ -15,7 +15,7 @@ Generate default implementation for server, you can use the base implementation ```groovy - annotationProcessor("io.github.danielliu1123:httpexchange-processor:3.2.5") + annotationProcessor("io.github.danielliu1123:httpexchange-processor:3.3.0") ``` @@ -27,7 +27,7 @@ Generate default implementation for server, you can use the base implementation io.github.danielliu1123 httpexchange-processor - 3.2.5 + 3.3.0 diff --git a/website/docs/40-configuration-properties.md b/website/docs/40-configuration-properties.md index 26ff77e..1d80f10 100644 --- a/website/docs/40-configuration-properties.md +++ b/website/docs/40-configuration-properties.md @@ -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}. <p> This feature needs \{@code spring-cloud-context} dependency in the classpath. <p color="orange"> NOTE: This feature is not supported by native image. @see <a href="https://github.com/spring-cloud/spring-cloud-release/wiki/AOT-transformations-and-native-image-support#refresh-scope">Refresh Scope</a>| 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** diff --git a/website/docs/50-version.mdx b/website/docs/50-version.mdx index 9c3493b..73c8c92 100644 --- a/website/docs/50-version.mdx +++ b/website/docs/50-version.mdx @@ -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 | \ No newline at end of file