API a integrace
API dokumentace se má opírat o generované artefakty z knowspread, ale neměla
by zůstat jen u schema popisu. Integrátor potřebuje vědět i scénáře, pořadí
kroků, idempotenci, chyby a dopady do produktu.
Zdroje
Sekce “Zdroje”| Zdroj | Využití |
|---|---|
swagger/rest/v1/swagger.yaml | OpenAPI kontrakt veřejného REST API. |
spec/rest/v1/* | Testy jako důkaz očekávaného chování. |
app/controllers/rest/v1/* | Reálná implementace. |
app/serializers/* | Tvar odpovědi a pojmenování polí. |
Navrhovaná struktura
Sekce “Navrhovaná struktura”- Autentizace
- Uživatelé
- Skupiny
- Obsah
- Learning events
- Webhooks
- Error handling
- Rate limits a retry strategie
Aktuální veřejné oblasti REST API
Sekce “Aktuální veřejné oblasti REST API”| Oblast | Účel |
|---|---|
| Authentication | Získání Bearer JWT tokenu přes client credentials. |
| Users | Správa uživatelů v company space. |
| User Groups | Skupiny, členství a přiřazený obsah. |
| Company Space | Základní informace o prostoru. |
| Contents | Vlastní obsah a blended learning obsah. |
| Learning Events | Události a jejich dny. |
| Content Participations | Reporting studia a certifikáty. |
| Webhooks | Odchozí notifikace směrem ke klientovi. |
Podrobný kontrakt generuje rswag do knowspread/swagger/rest/v1/swagger.yaml.