Strategická: Dospecifikování API
This commit is contained in:
parent
419a8b4d5a
commit
d206db8597
1 changed files with 32 additions and 2 deletions
|
@ -4,6 +4,16 @@ Obsazování území
|
||||||
API
|
API
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Odpověď na libovolný dotaz muže být HTTP error ve tvaru:
|
||||||
|
```
|
||||||
|
{
|
||||||
|
status: "error"
|
||||||
|
description: <str> # Popis chybové události (toto chceme vytisknout!)
|
||||||
|
http-code: <int>
|
||||||
|
http-name: <str> # Jméno chybového kódu
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
Parametry:
|
Parametry:
|
||||||
- token: Identifikuje uživatele, zjistí z hlavní stránky webu
|
- token: Identifikuje uživatele, zjistí z hlavní stránky webu
|
||||||
- game: S jakou hrou (popř. týmem ve hře) se chtějí bavit
|
- game: S jakou hrou (popř. týmem ve hře) se chtějí bavit
|
||||||
|
@ -77,7 +87,7 @@ nebo
|
||||||
]
|
]
|
||||||
} # Tah jako celek se provede, chyba jen u některých osob
|
} # Tah jako celek se provede, chyba jen u některých osob
|
||||||
|
|
||||||
nebo
|
nebo
|
||||||
|
|
||||||
{
|
{
|
||||||
status: "error"
|
status: "error"
|
||||||
|
@ -87,10 +97,30 @@ nebo
|
||||||
nebo
|
nebo
|
||||||
|
|
||||||
{
|
{
|
||||||
status: "too_late"
|
status: "too-late"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Požadavek na krok:
|
||||||
|
POST na `/api/step?game=<jmeno_hry>&token=<token>`
|
||||||
|
|
||||||
|
Odpověď:
|
||||||
|
```
|
||||||
|
{
|
||||||
|
status: "ok",
|
||||||
|
}
|
||||||
|
|
||||||
|
nebo
|
||||||
|
|
||||||
|
{
|
||||||
|
status: "error"
|
||||||
|
description: "Je zak\u00e1z\u00e1no krokovat tuto hru"
|
||||||
|
http-code: 403
|
||||||
|
http-name: "Forbidden"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Interní reprezentace
|
Interní reprezentace
|
||||||
====================
|
====================
|
||||||
|
|
Loading…
Reference in a new issue