https://github.com/luckperms/rest-api-java-client
A Java client for the LuckPerms REST API
https://github.com/luckperms/rest-api-java-client
Last synced: 12 months ago
JSON representation
A Java client for the LuckPerms REST API
- Host: GitHub
- URL: https://github.com/luckperms/rest-api-java-client
- Owner: LuckPerms
- License: mit
- Created: 2023-10-22T16:07:30.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-26T09:03:28.000Z (about 1 year ago)
- Last Synced: 2025-05-26T09:58:14.742Z (about 1 year ago)
- Language: Java
- Size: 187 KB
- Stars: 4
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# LuckPerms REST API - Java Client
The [LuckPerms REST API](https://github.com/LuckPerms/rest-api) allows developers to query LuckPerms data using HTTP calls.
This library allows developers to make these HTTP calls easily using a familiar Java API. :)
### Usage
Add a dependency to your Maven/Gradle buildscript:
e.g.
```groovy
repositories {
maven {
url 'https://oss.sonatype.org/content/repositories/snapshots'
}
}
dependencies {
implementation 'net.luckperms:rest-api-java-client:0.1-SNAPSHOT'
}
```
```xml
sonatype-snapshots
https://oss.sonatype.org/content/repositories/snapshots
net.luckperms
rest-api-java-client
0.1-SNAPSHOT
```
Then, create a new client and start making calls:
```java
LuckPermsRestClient client = LuckPermsRestClient.builder()
.baseUrl("http://localhost:8080")
.apiKey("abc123")
.build();
Response response = client.groups().get("admin").execute();
```