Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
GIVEN53 authored Nov 10, 2023
1 parent 2e042d1 commit 18a0569
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,12 @@ The api-versioning Java library helps you manage the API version using Spring Bo
The library automatically adds the version to the URI and provides a way to manage the version of the controller.

Supports JDK 17, Spring Boot 3.x
<br>

## Features
- Automatically appends the version to the URI through the `@ApiVersion` annotation.
- Allows customization of the URI prefix.
<br>

## Getting Started
### 1. Add the JitPack repository to your build file
Expand Down Expand Up @@ -48,11 +50,11 @@ dependencies {
implementation 'com.github.GIVEN53:api-versioning-library:{version}'
}
```
<br>

> **Warning**
> you need to replace `{version}` with the latest version.
<br>

## Usage
### 1. `@EnableApiVersion` annotation on your Application class
``` java
Expand Down Expand Up @@ -92,17 +94,19 @@ GET http://localhost:8080/v1/foo
POST http://localhost:8080/v1.1/foo/bar
POST http://localhost:8080/v1.2/foo/bar
```
<br>

## Setting properties
``` yml
api:
version:
uri-prefix: # The prefix of URI. Default is "". if you set "/api", the URI will be "/api/v1/..."
```
<br>
## Changelog
### 0.1.1
- Fixed build error
### 0.1.0
- Initial release
- Initial release

0 comments on commit 18a0569

Please sign in to comment.