https://github.com/zkxs/neos-api
https://github.com/zkxs/neos-api
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/zkxs/neos-api
- Owner: zkxs
- License: agpl-3.0
- Created: 2020-12-19T01:31:55.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-01T01:59:21.000Z (about 2 years ago)
- Last Synced: 2025-01-22T20:28:05.767Z (3 months ago)
- Language: Rust
- Size: 209 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Neos API
This application provides a several utility and testing APIs that I use for
various objects in Neos VR.
**It is still very much a work in progress.
Everything here is subject to change without notice!**
## Features
- HTTP GET and WebSocket debug routes
- New user session list
- Global public user list
- Caching to avoid unnecessary hits against the real Neos API.
## Usage
1. Download the [latest release](https://github.com/zkxs/neos-api/releases/latest)
2. Run neos-api.exe from a terminal (command prompt or powershell)
3. Ctrl+C when you want to kill it. If you didn't start it from a terminal kill it with Task Manager.
## API Documentation
API documentation is available [here](doc/api.md).