Logo David Burdelak
Słownik · Web development

Co to jest endpoint?

Ostatnia aktualizacja:

Endpoint (punkt końcowy) to konkretny adres URL w API, pod którym aplikacja przyjmuje żądania i zwraca odpowiedź. Razem z metodą HTTP określa, jaka operacja zostanie wykonana, na przykład pobranie listy wpisów albo dodanie nowego.

Jak wygląda endpoint?

Przykład: GET /api/wpisy/15 pobiera wpis o numerze 15, a POST /api/wpisy tworzy nowy. Adres opisuje zasób, a metoda działanie. Odpowiedź zwykle ma format JSON i kod statusu informujący o wyniku, np. 200, 404 lub 500.

Jak projektować endpointy?

  • używaj rzeczowników w liczbie mnogiej zamiast czasowników w adresie,
  • stosuj właściwe metody (GET, POST, PUT, DELETE),
  • zwracaj czytelne kody błędów i komunikaty,
  • wersjonuj API, np. /api/v1/.

Bezpieczeństwo endpointów

Każdy endpoint to potencjalne wejście dla atakującego. Wymagaj uwierzytelnienia, waliduj dane, ogranicz liczbę żądań i nie zwracaj więcej informacji, niż potrzeba. Publiczny, niezabezpieczony endpoint bywa źródłem wycieków danych.

Przykład odpowiedzi API

Zapytanie GET /api/v1/wpisy/15 może zwrócić kod 200 i JSON z polami id, tytul i autor, a dla nieistniejącego numeru kod 404 z komunikatem o błędzie. Dokumentację endpointów warto zapisać w standardzie OpenAPI, aby można ją było wygenerować i testować w narzędziach takich jak Swagger UI lub Postman.

Wywołanie adresu niedozwoloną metodą HTTP serwer odrzuca, zwracając błąd 405 Method Not Allowed.

Zobacz w praktyce

Powiązane pojęcia

Wszystkie hasła z kategorii Web development