Docs: Add docs for API routes

and remove legacy import instructions
This commit is contained in:
2023-04-17 18:15:37 +02:00
parent 85cebd2886
commit 969c257ee4
3 changed files with 244 additions and 4 deletions

25
Docs/API/README.md Normal file
View File

@@ -0,0 +1,25 @@
# API Documentation
## Introduction
This API provides CRU (Create, Read, Update) operations for various models.
The API requires an API key for some operations.
The endpoints provided by this API are:
## Generic:
- / - List all routes (JSON Response)
- /ping - Returns pong
- /stats - Simple stats about the bot (Record counts and uptime)
- /most-recent-drop - Returns the most recent drop (Requires API Key)
## For characters:
- [`/characters`](api/characters.md#get-characters)
- [`/characters/:character_id`](api/characters.md#get-characterscharacter_id)
## For groups:
_TODO_
## For Badges:
_TODO_