Endpointy REST API
Caution
Ukážková stránka: Toto je ukážková stránka, ktorá predvádza funkciu dokumentácie s viacerými kartami. Obsah slúži len na ilustráciu.
Naše REST API poskytuje endpointy na prístup k dátam a ich úpravu. Všetky endpointy vracajú dáta vo formáte JSON.
Základná URL
Všetky API požiadavky smerujte na túto základnú URL:
https://api.example.com/v1Endpointy pre používateľov
Získanie všetkých používateľov
GET /usersVráti zoznam všetkých používateľov. Podporuje parametre stránkovania.
Parametre dopytu:
| Parameter | Typ | Popis |
|---|---|---|
| page | integer | Číslo strany (predvolene: 1) |
| limit | integer | Počet záznamov na stranu (predvolene: 50, max: 100) |
| sort | string | Pole na zoradenie (napríklad “name”, “created_at”) |
Odpoveď:
{ "data": [ { "id": "user_123", "name": "John Doe", "created_at": "2023-01-15T08:30:00Z" }, // More users... ], "meta": { "total": 250, "page": 1, "limit": 50 }}Získanie používateľa podľa ID
GET /users/{id}Vráti jedného používateľa podľa ID.
Odpoveď:
{ "data": { "id": "user_123", "name": "John Doe", "created_at": "2023-01-15T08:30:00Z", "profile": { "bio": "Software developer", "location": "New York", "avatar_url": "https://example.com/avatars/john.jpg" } }}Endpointy pre produkty
Získanie všetkých produktov
GET /productsVráti zoznam všetkých produktov. Podporuje filtrovanie a stránkovanie.
Parametre dopytu:
| Parameter | Typ | Popis |
|---|---|---|
| category | string | Filtrovanie podľa kategórie |
| min_price | number | Filtrovanie podľa minimálnej ceny |
| max_price | number | Filtrovanie podľa maximálnej ceny |
| page | integer | Číslo strany (predvolene: 1) |
| limit | integer | Počet záznamov na stranu (predvolene: 50, max: 100) |
Odpoveď:
{ "data": [ { "id": "prod_123", "name": "Example Product", "description": "This is an example product", "price": 49.99, "category": "electronics" }, // More products... ], "meta": { "total": 350, "page": 1, "limit": 50 }}Spracovanie chýb
Všetky endpointy dodržiavajú štandardné stavové kódy HTTP a v odôvodnených prípadoch obsahujú podrobné chybové hlásenia:
| Stavový kód | Popis |
|---|---|
| 200 | OK, požiadavka prebehla úspešne |
| 400 | Bad Request, neplatné parametre |
| 401 | Unauthorized, vyžaduje sa autentifikácia |
| 403 | Forbidden, nedostatočné oprávnenia |
| 404 | Not Found, zdroj neexistuje |
| 429 | Too Many Requests, prekročený limit požiadaviek |
| 500 | Internal Server Error, nastala chyba servera |
Chybové odpovede obsahujú správu s vysvetlením, čo sa pokazilo:
{ "error": { "code": "invalid_parameter", "message": "The parameter 'email' is not a valid email address", "request_id": "req_abc123" }}