Punkt końcowy interfejsu API to punkt połączenia między dwoma programami. Interfejsy API mają punkty końcowe dla każdego zasobu. Punkty końcowe określają dokładną lokalizację zasobu na serwerze.
Gdy aplikacja kliencka żąda informacji od serwera, przechodzi przez interfejs API. Który następnie uzyskuje dostęp do żądania i przetwarza odpowiedź z serwera. Następnie API przekazuje żądane informacje z punktu końcowego do aplikacji.
Twój interfejs API jest wydajny, jeśli może skutecznie komunikować się za pośrednictwem swoich punktów końcowych. Ułatwia użytkownikom dostęp do zasobów, poprawiając komfort użytkowania.
Jak działa punkt końcowy interfejsu API?
Zintegrowane systemy komunikują się za pośrednictwem interfejsów API. Jeden system wysyła żądanie do API, używając format taki jak SOAP lub REST. Serwer odbiera żądania i przesyła odpowiedź z powrotem do API. Lokalizacja tego żądanego zasobu jest punktem końcowym.
Zanim punkt końcowy przetworzy żądanie, klient musi podać adres URL, nagłówki i treść. Nagłówki zawierają metadane dotyczące żądania oraz dane dotyczące treści przesłane do serwera. Serwer może również łączyć się z bazą danych, która metody API można uzyskać dostęp.
Punkty końcowe interfejsu API zazwyczaj współpracują z metodami HTTP, takimi jak GET, DELETE, PATCH lub POST. Metody określają, jak używać punktu końcowego. Gdy klient wysyła żądanie, musi je sformułować tak, aby zawierało metodę żądania oraz adres URL, na przykład:
DOSTAWAĆ https://example.com/books/authorsNazewnictwo jest trudne, niezależnie od tego, czy chodzi o punkty końcowe API, sieciowe urządzenia sprzętowelub funkcje i zmienne. Powinieneś poznać kilka najlepszych praktyk, których możesz użyć, aby upewnić się, że punkty końcowe API są zasobem.
1. Użyj ukośnika
Zawsze używaj ukośników do oddzielania zasobów URI. Ukośniki pomagają również pokazać hierarchię zasobów. Oto przykład:
https://example.com/books/authors2. Używaj rzeczowników, a nie czasowników
Do nazwania zasobu należy używać tylko rzeczowników. Rzeczowniki opisują, do czego służy zasób, w przeciwieństwie do czasownika opisującego, co robi zasób. Oto przykład dobrego i złego sposobu nazywania punktów końcowych API.
Dobre nazewnictwo:
https://example.com/api/getBooksZłe nazewnictwo:
http://example.com/api/books3. Używaj rzeczowników w liczbie mnogiej, a nie w liczbie pojedynczej
Punkty końcowe interfejsu API należy zawsze nazywać rzeczownikami w liczbie mnogiej. Wskazuje to użytkownikowi, że na serwerze jest więcej niż jeden zasób. Użycie rzeczownika w liczbie pojedynczej może zmylić użytkownika, myśląc, że istnieje tylko jeden zasób.
Dobre nazewnictwo:
https://example.com/api/book/3Złe nazewnictwo:
http://example.com/api/books/34. Użyj małych liter
Powinieneś wpisać wszystkie adresy URL małymi literami. Obejmuje to adresy URL punktów końcowych interfejsu API. Oto przykład:
Dobre nazewnictwo:
http://example.com/api/Books/3Złe nazewnictwo:
http://example.com/api/books/35. Użyj łączników do oddzielania słów
Użyj łączników, aby oddzielić połączone słowa. Łączniki dają bardziej czytelne frazy niż wielkie litery lub podkreślenia. Są również lepsze dla celów SEO.
Dobre nazewnictwo:
https://example.com/api/books/33/front_coverZłe nazewnictwo:
https://example.com/api/books/33/front-cover6. Nie dodawaj rozszerzeń plików
Nie musisz dodawać rozszerzenia pliku do punktów końcowych interfejsu API. Chociaż nie ma to wpływu na dane wyjściowe, rozszerzenie utrudnia odczytanie zasobu. Powoduje to również, że zasób jest mniej elastyczny, co powoduje jego uszkodzenie w przypadku zmiany rozszerzenia w przyszłości.
Dobre nazewnictwo:
https://example.com/api/books.xmlZłe nazewnictwo:
https://example.com/api/books7. Uwzględnij wersjonowanie
Powinieneś zawsze nazywać punkty końcowe interfejsu API zgodnie z wersją. Jest to ważne, jeśli wprowadzasz poważne zmiany w interfejsie API. Pomaga rozróżnić dwie lub więcej wersji API, z których pochodzi zasób. Możesz wskazać wersję na początku punktu końcowego.
Na przykład:
https://example.com/api/v3/booksDlaczego warto rozważyć najlepsze praktyki API?
Interfejsy API stały się podstawą współczesnego programowania. Poprawiają współpracę, zachęcają do innowacji i poprawiają bezpieczeństwo aplikacji.
Niezależnie od tego, czy używasz nowych narzędzi, czy zarządzasz istniejącymi, interfejsy API upraszczają ten proces. Dlatego ważne jest, aby mieć punkty końcowe, które poprawiają wrażenia użytkownika. Nazewnictwo i struktura punktów końcowych interfejsu API określają wydajność interfejsu API.
Upewnij się, że korzystasz z najlepszych praktyk do tworzenia wydajnych punktów końcowych API.