Skip to content

Commit 54f056a

Browse files
committed
merge: origin main
2 parents 9c1ba99 + 18a0569 commit 54f056a

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,12 @@ The api-versioning Java library helps you manage the API version using Spring Bo
77
The library automatically adds the version to the URI and provides a way to manage the version of the controller.
88

99
Supports JDK 17, Spring Boot 3.x
10+
<br>
1011

1112
## Features
1213
- Automatically appends the version to the URI through the `@ApiVersion` annotation.
1314
- Allows customization of the URI prefix.
15+
<br>
1416

1517
## Getting Started
1618
### 1. Add the JitPack repository to your build file
@@ -48,11 +50,11 @@ dependencies {
4850
implementation 'com.github.GIVEN53:api-versioning-library:{version}'
4951
}
5052
```
51-
<br>
52-
5353
> **Warning**
5454
> you need to replace `{version}` with the latest version.
5555
56+
<br>
57+
5658
## Usage
5759
### 1. `@EnableApiVersion` annotation on your Application class
5860
``` java
@@ -92,17 +94,19 @@ GET http://localhost:8080/v1/foo
9294
POST http://localhost:8080/v1.1/foo/bar
9395
POST http://localhost:8080/v1.2/foo/bar
9496
```
97+
<br>
9598

9699
## Setting properties
97100
``` yml
98101
api:
99102
version:
100103
uri-prefix: # The prefix of URI. Default is "". if you set "/api", the URI will be "/api/v1/..."
101104
```
105+
<br>
102106
103107
## Changelog
104108
### 0.1.1
105109
- Fixed build error
106110
107111
### 0.1.0
108-
- Initial release
112+
- Initial release

0 commit comments

Comments
 (0)