Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stuyk/altv-athena-api
A REST Plugin for Athena
https://github.com/stuyk/altv-athena-api
Last synced: about 22 hours ago
JSON representation
A REST Plugin for Athena
- Host: GitHub
- URL: https://github.com/stuyk/altv-athena-api
- Owner: Stuyk
- Created: 2021-12-16T18:40:00.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-05-16T20:43:54.000Z (over 2 years ago)
- Last Synced: 2024-05-01T16:36:17.518Z (8 months ago)
- Language: TypeScript
- Size: 11.7 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Athena Framework - REST API
This feeds data from the Server to anyone who would like to access the endpoint. It's a relatively simple plugin that is more data centric.
It is highly recommended that if you plan on using this plugin that you limit who can access the port `9090` by IP.
**You as the end-user are responsible for securing data.**
# GET
`:variable` means you provide the data to get the result. Everything is case sensitive.
_\* Some sensitive data removed from response._
## Account Specific
| Request | Description | Response |
| ---------------------------------- | ----------- | ------------ |
| `localhost:9090/accounts/:discord` | Get Account | ``* |
## Player Specific
| Request | Description | Response |
| ----------------------------------------- | ---------------------------- | ------------------- |
| `localhost:9090/players/all` | Get Players | `Array` |
| `localhost:9090/players/name/:name` | Get Character by Name | `Character` |
| `localhost:9090/players/discord/:discord` | Get Characters by Discord ID | `Array` |
## Vehicle Specific
| Request | Description | Response |
| --------------------------------------- | ---------------------- | -------------------- |
| `localhost:9090/vehicles/all` | Get Vehicles | `Array` |
| `localhost:9090/vehicles/character/:id` | Get Character Vehicles | `Array` |
All `GET` Requests Return a JSON Response Object
```ts
{
"version": number,
"data": Array
}
```
# Installation
- Clone the latest version of the archiv, alternatively you can create a Fork or install this plugin as a git submodule
* Fastify dependencie will be auto installed through the Athena Framework
### Drag and Drop
- Recommend for everyone
```ts
git clone https://github.com/Stuyk/altv-athena-api
```
### Git Submodule (Terminal)
- In src/core/plugins/
- Recommend for experienced users
```ts
git submodule add https://github.com/Stuyk/altv-athena-api
```
# Verification of Installation
Open Browser and Visit
```
localhost:9090
```
# Uninstallation
Delete the folder `src/core/plugins/altv-athena-api`
Run the following in a Terminal:
```
npm uninstall fastify
```