API JSON i usługi REST: Kompletny przewodnik dewelopera

# API JSON i usługi REST: Kompletny przewodnik dewelopera

Usługi REST (Representational State Transfer) stały się standardem komunikacji w internecie, a JSON jest ich najpopularniejszym językiem. W tym przewodniku dowiesz się, jak tworzyć profesjonalne interfejsy API.

Podstawy REST

REST opiera się na zasobach (np. użytkownicy, zamówienia) oraz akcjach wykonywanych na nich za pomocą metod HTTP:

• GET: Pobieranie danych (np. lista produktów).
• POST: Tworzenie nowego zasobu.
• PUT / PATCH: Aktualizacja istniejących danych.
• DELETE: Usuwanie zasobu.

---

Przykład API w JavaScript (Express.js)

import express from 'express';
const app = express();
app.use(express.json());

// Pobieranie użytkowników
app.get('/api/users', (req, res) => {
  res.json([{ id: 1, name: 'Alicja' }]);
});

// Tworzenie użytkownika
app.post('/api/users', (req, res) => {
  const newUser = req.body;
  res.status(201).json(newUser);
});

app.listen(3000);

---

Obsługa odpowiedzi API

Warto trzymać się spójnego formatu odpowiedzi, co ułatwia pracę deweloperom frontendowym:

Sukces:

{
  "success": true,
  "data": { "id": 1, "name": "Alicja" }
}

Błąd:

{
  "success": false,
  "error": { "code": "NOT_FOUND", "message": "Nie znaleziono użytkownika" }
}

---

Najlepsze praktyki

Wersjonowanie: Zawsze dodawaj wersję do adresu URL (np. /api/v1/...).

Kody statusu: Używaj oficjalnych kodów HTTP (np. 200 OK, 201 Created, 404 Not Found).

Uwierzytelnianie: Korzystaj z bezpiecznych rozwiązań, takich jak tokeny Bearer (JWT).

Dokumentacja: Używaj narzędzi typu Swagger, aby Twoje API było łatwe do zrozumienia dla innych.

Podsumowanie

Budowanie API REST z wykorzystaniem formatu JSON to fundament nowoczesnego backendu. Dbając o standardy i spójność, tworzysz rozwiązania, które są łatwo skalowalne i przyjazne dla innych deweloperów.