REST API-végpontok
Caution
Demóoldal - Ez az oldal a többfüles dokumentációs funkciót mutatja be. A tartalma csak szemléltetésre szolgál.
A REST API-nk végpontokat kínál az adatok eléréséhez és módosításához. Minden végpont JSON formátumban adja vissza az adatokat.
Alap-URL
Minden API-kérést a következő alap-URL-re küldj:
https://api.example.com/v1Felhasználói végpontok
Az összes felhasználó lekérése
GET /usersVisszaadja az összes felhasználó listáját. Támogatja a lapozási paramétereket.
Lekérdezési paraméterek:
| Paraméter | Típus | Leírás |
|---|---|---|
| page | integer | Oldalszám (alapértelmezés: 1) |
| limit | integer | Oldalankénti rekordok száma (alapértelmezés: 50, maximum: 100) |
| sort | string | A rendezés alapjául szolgáló mező (például “name”, “created_at”) |
Válasz:
{ "data": [ { "id": "user_123", "name": "John Doe", "created_at": "2023-01-15T08:30:00Z" }, // More users... ], "meta": { "total": 250, "page": 1, "limit": 50 }}Felhasználó lekérése azonosító alapján
GET /users/{id}Egyetlen felhasználót ad vissza az azonosítója alapján.
Válasz:
{ "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" } }}Termékvégpontok
Az összes termék lekérése
GET /productsVisszaadja az összes termék listáját. Támogatja a szűrést és a lapozást.
Lekérdezési paraméterek:
| Paraméter | Típus | Leírás |
|---|---|---|
| category | string | Szűrés kategória szerint |
| min_price | number | Szűrés minimális ár szerint |
| max_price | number | Szűrés maximális ár szerint |
| page | integer | Oldalszám (alapértelmezés: 1) |
| limit | integer | Oldalankénti rekordok száma (alapértelmezés: 50, maximum: 100) |
Válasz:
{ "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 }}Hibakezelés
Minden végpont a szokásos HTTP-státuszkódokat követi, és ahol indokolt, részletes hibaüzenetet is ad:
| Státuszkód | Leírás |
|---|---|
| 200 | OK, a kérés sikeres volt |
| 400 | Bad Request, érvénytelen paraméterek |
| 401 | Unauthorized, hitelesítés szükséges |
| 403 | Forbidden, nincs elegendő jogosultság |
| 404 | Not Found, az erőforrás nem létezik |
| 429 | Too Many Requests, túllépted a kérési korlátot |
| 500 | Internal Server Error, szerveroldali hiba történt |
A hibaválaszok tartalmaznak egy üzenetet arról, hogy mi ment félre:
{ "error": { "code": "invalid_parameter", "message": "The parameter 'email' is not a valid email address", "request_id": "req_abc123" }}