Skip to content

Commit 398ae90

Browse files
EndkindEndkind
committed
Erstellen von API-Dokumentationsdateien für v1, einschließlich Endpunkte für Info und Status, sowie Aktualisierung der Homepage und des Templates mit Autoreninformationen.
1 parent 2b97e61 commit 398ae90

6 files changed

Lines changed: 175 additions & 4 deletions

File tree

‎api/v1/index.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
date: 2025-06-01
3+
category: [API]
4+
tags: [APIv1]
5+
description: API
6+
7+
author:
8+
- name: Endkind
9+
link: https://github.com/Endkind
10+
avatar: https://github.com/Endkind.png
11+
---
12+
13+
# v1
14+
15+
Diese API stellt Informationen und Statistiken zu Game Servern bereit.
16+
17+
**Basis-URL:** `https://api.server-list.games`
18+
19+
Falls du lieber die automatisch generierte FastAPI-Dokumentation nutzen möchtest, findest du sie hier:
20+
[https://api.server-list.games/docs](https://api.server-list.games/docs)
21+
22+
## Endpunkte
23+
24+
- [Info Endpoint](info.md)
25+
- [Status Endpoint](status.md)

‎api/v1/info.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
date: 2025-06-01
3+
category: [API]
4+
tags: [APIv1]
5+
description: API - Info
6+
7+
author:
8+
- name: Endkind
9+
link: https://github.com/Endkind
10+
avatar: https://github.com/Endkind.png
11+
---
12+
13+
# Info
14+
15+
Abrufen von allgemeinen Informationen zu einem bestimmten Game Server.
16+
17+
## Endpoint
18+
19+
`GET /v1/server/{game_type}/{name}/info`
20+
21+
### Parameters
22+
23+
- `game_type` *(Pfad, erforderlich)* – Enum: `minecraft_java`, `minecraft_bedrock`
24+
- `name` *(Pfad, erforderlich)* – Der interne Servername (String)
25+
26+
### Responses
27+
28+
- **200 OK** – Successful Response:
29+
30+
```json
31+
{
32+
"name": "string",
33+
"display_name": "string",
34+
"type": "string",
35+
"ip": "string",
36+
"port": 0,
37+
"mods": []
38+
}
39+
```
40+
41+
- **404 Not Found** – Game Server Not found
42+
43+
- **422 Validation Error** – Validation Error:
44+
45+
```json
46+
{
47+
"detail": [
48+
{
49+
"loc": [
50+
"string",
51+
0
52+
],
53+
"msg": "string",
54+
"type": "string"
55+
}
56+
]
57+
}
58+
```

‎api/v1/status.md‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
date: 2025-06-01
3+
category: [API]
4+
tags: [APIv1]
5+
description: API - Info
6+
7+
author:
8+
- name: Endkind
9+
link: https://github.com/Endkind
10+
avatar: https://github.com/Endkind.png
11+
---
12+
13+
# Status
14+
15+
Abrufen von Statusdaten zu einem Game Server über einen bestimmten Zeitraum.
16+
17+
## Endpoint
18+
19+
`GET /v1/server/{game_type}/{name}/status/{time_span}`
20+
21+
### Parameters
22+
23+
- `game_type` *(Pfad, erforderlich)* – Enum: `minecraft_java`, `minecraft_bedrock`
24+
- `name` *(Pfad, erforderlich)* – Der interne Servername (String)
25+
- `time_span` *(Pfad, erforderlich)* – Enum: `12h`, `24h`, `48h`
26+
27+
### Responses
28+
29+
- **200 OK** – Successful Response:
30+
31+
```json
32+
{
33+
"server_info": {
34+
"name": "string",
35+
"display_name": "string",
36+
"type": "string",
37+
"ip": "string",
38+
"port": 0,
39+
"mods": []
40+
},
41+
"status": {}
42+
}
43+
```
44+
45+
- **404 Not Found** – Game Server Not found
46+
47+
- **422 Validation Error** – Validation Error:
48+
49+
```json
50+
{
51+
"detail": [
52+
{
53+
"loc": [
54+
"string",
55+
0
56+
],
57+
"msg": "string",
58+
"type": "string"
59+
}
60+
]
61+
}
62+
```

‎index.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
date: 2025-06-01
3+
description: Übersicht über die Dokumentation und API-Endpunkte
4+
5+
author:
6+
- name: Endkind
7+
link: https://github.com/Endkind
8+
avatar: https://github.com/Endkind.png
9+
---
10+
11+
# Homepage
12+
13+
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.

‎retype.yml‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ favicon: static/logo.png
1717
footer:
1818
copyright: "© Copyright {{ year }}. [EnderGameServerList](https://github.com/EnderGameServerList) All rights reserved."
1919
links:
20-
- text: Homepage
20+
- text: GitHub Organization
2121
link: https://github.com/EnderGameServerList
2222
- text: License
2323
link: https://github.com/EnderGameServerList/docs/blob/main/LICENSE
@@ -29,5 +29,6 @@ edit:
2929
editor:
3030
enabled: false
3131

32-
explude:
33-
- example.md
32+
exclude:
33+
- "*example*"
34+
- "*template*"

test.md renamed to template.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1-
# Test
1+
---
2+
date: 2025-05-31
3+
category: [example]
4+
tags: [example]
5+
description: Lorem Ipsum
6+
7+
author:
8+
- name: Endkind
9+
link: https://github.com/Endkind
10+
avatar: https://github.com/Endkind.png
11+
---
12+
13+
# Template
214

315
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.

0 commit comments

Comments
 (0)