W tym artykule pokażemy Ci jak pracować z API na naszej pro-levelowej platformie no-code, AppMaster.io. Ale, najpierw, przypomnijmy kilka podstawowych informacji o API.
Wprowadzenie
API oznacza interfejs programowania aplikacji. Dzięki nim klient i serwer mogą się ze sobą komunikować. Klient i serwer wysyłają żądania i odpowiedzi, a API działa jako pośrednik między nimi.
Ta interakcja klient-serwer musi być prosta, zrozumiała i wygodna. Upraszcza to zarówno zadania programistów (nie trzeba wymyślać na nowo nowej usługi), jak i użytkowników (usługa jest łatwiejsza do nauczenia się, jeśli działa znajomo). Istnieje kilka rodzajów API:
- Web service APIs, XML-RPC, i JSON-RPC, SOAP;
- WebSockets APIs;
- API oparte na bibliotekach, Java Script;
- API oparte na klasach, C# API, Java.
Na platformie no-code AppMaster.io używamy stylu REST API.
REST czyli cały Representational State Transfer to architektoniczny styl interakcji (wymiany informacji) pomiędzy klientem a serwerem. Usługi w REST API komunikują się za pomocą protokołu HTTP.
Styl REST ma pewne zalety. Główną zaletą REST jest doskonała elastyczność. REST składa się z prostych wytycznych, dzięki czemu programiści mogą implementować wymagania w swoim formacie. REST ma wysoką wydajność, co jest bardzo ważne, na przykład dla szybkiego ładowania na urządzeniach mobilnych. Dlatego wszystkie duże firmy, takie jak Twitter i Google, od dawna wdrażają REST API dla swoich produktów. Więcej o pracy i głównych zaletach REST API można przeczytać w naszym artykule.
Struktura dowolnego żądania zawiera pięć głównych elementów: Metoda HTTP, punkty końcowe, nagłówki i ciało, parametry żądania.
REST API wykorzystuje 4 podstawowe metody HTTP do pracy z zasobem (informacją), a każda z nich opisuje, co należy zrobić z zasobem:
- POST - tworzenie zasobu;
- GET - pobieranie zasobu;
- PUT - aktualizacja zasobu;
- DELETE - usunięcie zasobu.
Zasób to dowolna informacja (dokument, obraz, wideo, tekst i tak dalej). Na platformie AppMaster.io no-code informacje te są dostarczane do klienta w kilku formatach, w tym najpopularniejszym - JSON.
Punkt końcowy zawiera URI - Uniform Resource Identifier (jednolity identyfikator zasobów), który wskazuje, gdzie i jak znaleźć dany zasób w Internecie i zawiera adres URL (URL lub Uniform Resource Location to pełny adres internetowy).
Nagłówki przekazują informacje zarówno klientowi, jak i serwerowi. Nagłówki dostarczają głównie dane uwierzytelniające: klucz API, nazwę lub adres IP komputera, na którym zainstalowany jest serwer, oraz format odpowiedzi.
Ciało jest potrzebne do przekazania dodatkowych informacji do serwera: dane ciała to dane, które np. chcesz dodać lub zastąpić.
Dokumentacja API dla Twojej aplikacji na naszej platformie jest generowana automatycznie i przechowywana w formacie OpenAPI (Swagger) w jej backendzie.
Nie musisz dokładnie rozumieć, jak to działa, aby nauczyć się budować API na AppMaster.io. Zrozumiesz podstawowe zasady, poznając narzędzia platformy. Ponadto centralna część API jest tworzona przez AppMaster.io. Większość ustawień jest wykonywana domyślnie lub podczas łączenia modułów. Na przykład nasz moduł dostarcza narzędzi do integracji z API dla poczty.
Będziesz musiał ręcznie wprowadzić drobne zmiany w niektórych ustawieniach API podczas integrowania (podłączania) swojej aplikacji z innymi aplikacjami lub zasobami zewnętrznymi. Następnie przyjrzymy się, jak to zrobić.
Tworzenie API za pomocą platformy no-code AppMaster.io
Tak więc, możesz znaleźć ustawienia API w kilku miejscach na naszej platformie.
Jak stworzyć punkt końcowy API na platformie no-code AppMaster.io
Zaloguj się na swoje konto do istniejącego projektu.
Przejdź do Data Model Designer. W Data Model Designer zobaczysz modele z danymi, które chcesz przetwarzać za pomocą API endpointów. W każdym projekcie, na początku, zawsze domyślnie jest jeden model - Użytkownik. Jeśli jesteś w nowym projekcie i nie masz jeszcze swoich modeli, utwórz je.
Przypisz linki pomiędzy swoimi modelami i zapisz projekt.
Przejdź do sekcji Endpoints w lewym menu ekranu.
Zobaczysz tu listę wszystkich swoich endpointów i dostępnych dla nich metod REST API połączonych z każdym modelem w polu projektu. Usuniesz zbędne metody i zmienisz ich ustawienia (ikona koła zębatego i ikona kosza).
Jeśli na liście nie ma odpowiedniego punktu końcowego, możesz stworzyć nowy, klikając przycisk New Endpoint i wybierając odpowiedni typ. Otworzy się okno modalne z ustawieniami Endpointa.
Jak stworzyć zewnętrzne API na platformie no-code AppMaster.io
Przejdź do sekcji Business Logic w lewym menu.
Tutaj możesz utworzyć zewnętrzne żądanie API w zakładce External API Request (ta opcja jest w fazie beta).
Ponadto, jak już wspomnieliśmy, cała dokumentacja jest generowana automatycznie i zapisywana w formacie OpenAPI (Swagger) w back-end Twojej aplikacji.
Swagger to dokumentacja i możliwość testowania wszystkich punktów końcowych bezpośrednio na miejscu, bez korzystania z aplikacji innych firm, takich jak Postman.
Podsumowanie
Jak widać, tworzenie i zmiana ustawień API za pomocą no-code jest bardzo prosta i zajmuje minimum czasu. Jeśli nie masz jeszcze konta na AppMaster.io, dołącz do nas i zapisz się na wersję próbną.
