https://github.com/tsukinoko-kun/papermc-web-api

Secure web api for Minecraft paper servers with OAuth2
https://github.com/tsukinoko-kun/papermc-web-api

api api-server oauth oauth-server oauth-service papermc

Last synced: about 1 year ago
JSON representation

Secure web api for Minecraft paper servers with OAuth2

• Host: GitHub
• URL: https://github.com/tsukinoko-kun/papermc-web-api
• Owner: tsukinoko-kun
• License: mit
• Created: 2023-08-28T14:26:40.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-09-25T13:03:45.000Z (over 2 years ago)
• Last Synced: 2025-03-14T19:17:28.238Z (over 1 year ago)
• Topics: api, api-server, oauth, oauth-server, oauth-service, papermc
• Language: Java
• Homepage: https://frank-mayer.github.io/papermc-web-api/papermc-web-api.jar
• Size: 78.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# PaperMC Web API

[![Deploy build artifacts](https://github.com/Frank-Mayer/papermc-web-api/actions/workflows/deploy.yml/badge.svg)](https://github.com/Frank-Mayer/papermc-web-api/actions/workflows/deploy.yml)

[![this product is ai free](https://this-product-is-ai-free.github.io/badge.svg)](https://this-product-is-ai-free.github.io)

## Requirements

- [PaperMC](https://papermc.io/) server. Look at the `api-version` in [`paper-plugin.yml`](https://github.com/Frank-Mayer/papermc-web-api/blob/main/src/main/resources/paper-plugin.yml) to see the minimum version.

## Setup

1. Download the latest [jar file](https://frank-mayer.github.io/papermc-web-api/papermc-web-api.jar) and put it into your plugins folder.

1. Start the Paper server. This plugin will create a default config file for you.

1. Stop the Paper server.

1. Edit the config file. [Read the docs](https://github.com/Frank-Mayer/papermc-web-api/wiki).

1. You are good to go.

## Disclaimer

This plugin uses the [`com.sun.net.httpserver.HttpServer`](https://docs.oracle.com/javase/8/docs/jre/api/net/httpserver/spec/com/sun/net/httpserver/HttpServer.html) with the `http` protocol wich is not encrypted.

If your API is publicly avaliable you should use a proxy like [NGINX](https://www.nginx.com/) to encrypt its connection.

This server is resource intensive because it requires reflection.

I tried to do as much reflection as possible once at program startup to avoid it during runtime.

Read more about the reasoning [here](https://blogs.oracle.com/javamagazine/post/java-reflection-performance)

## Documentation

There is a [wiki](https://github.com/Frank-Mayer/papermc-web-api/wiki) for this repository containing the full documentation.