Questo articolo vi mostrerà come lavorare con le API sulla nostra piattaforma no-code di livello pro, AppMaster.io. Prima, però, vi ricordiamo alcune informazioni di base sulle API.
Introduzione
API significa Application Programming Interface (Interfaccia di programmazione dell'applicazione). Sono il modo in cui il client e il server possono comunicare tra loro. Il client e il server inviano richieste e risposte e l'API funge da intermediario tra loro.
Questa interazione client-server deve essere semplice, comprensibile e conveniente. Semplifica i compiti degli sviluppatori (non è necessario reinventare un nuovo servizio) e degli utenti (un servizio è più facile da imparare se funziona in modo familiare). Esistono diversi tipi di API:
- API per servizi Web, XML-RPC e JSON-RPC, SOAP;
- API WebSockets;
- API basate su librerie, Java Script;
- API basate su classi, API C#, Java.
Sulla piattaforma no-code AppMaster.io utilizziamo lo stile API REST.
REST o l'intero Representational State Transfer è lo stile architettonico di interazione (scambio di informazioni) tra il client e il server. I servizi dell'API REST comunicano utilizzando il protocollo HTTP.
Lo stile REST presenta alcuni vantaggi. Il vantaggio principale di REST è l'eccellente flessibilità. REST è costituito da linee guida semplici, che consentono agli sviluppatori di implementare i requisiti nel loro formato. REST ha prestazioni elevate, che sono molto importanti, ad esempio, per il caricamento veloce sui dispositivi mobili. Per questo motivo, tutte le grandi aziende come Twitter e Google hanno da tempo implementato le API REST per i loro prodotti. Per saperne di più sul funzionamento e sui principali vantaggi dell'API REST, consultate il nostro articolo.
La struttura di ogni richiesta comprende cinque componenti principali: Metodo HTTP, endpoint, intestazioni e corpo, parametri della richiesta.
L'API REST utilizza 4 metodi HTTP di base per lavorare con una risorsa (informazione), e ognuno di essi descrive cosa deve essere fatto con la risorsa:
- POST - creazione di una risorsa;
- GET - ottenimento di una risorsa;
- PUT - aggiornamento di una risorsa;
- DELETE - eliminazione di una risorsa.
Una risorsa è una qualsiasi informazione (documento, immagine, video, testo e così via). Sulla piattaforma no-code AppMaster.io, queste informazioni vengono fornite al client in diversi formati, tra cui il più comune: JSON.
L'endpoint contiene un URI - Uniform Resource Identifier (identificatore uniforme di risorse), che indica dove e come trovare una risorsa su Internet e include un URL (URL o Uniform Resource Location è un indirizzo web completo).
Le intestazioni trasmettono informazioni sia al client che al server. Le intestazioni forniscono principalmente dati di autenticazione: una chiave API, il nome o l'indirizzo IP del computer su cui è installato il server e il formato della risposta.
Il corpo è necessario per passare informazioni aggiuntive al server: i dati del corpo sono dati che, ad esempio, si desidera aggiungere o sostituire.
La documentazione API per la vostra applicazione sulla nostra piattaforma viene generata automaticamente e memorizzata nel formato OpenAPI (Swagger) nel suo backend.
Non è necessario capire esattamente come funziona per imparare a costruire un'API su AppMaster.io. I principi di base saranno compresi imparando a conoscere gli strumenti della piattaforma. Inoltre, la parte centrale dell'API è creata da AppMaster.io. La maggior parte delle impostazioni viene effettuata per impostazione predefinita o quando si collegano i moduli. Ad esempio, il nostro modulo fornisce strumenti per l'integrazione con le API per la posta.
È necessario apportare manualmente piccole modifiche ad alcune impostazioni delle API quando si integra (si collega) l'applicazione ad altre applicazioni o risorse esterne. Di seguito vedremo come fare.
Creazione di API con la piattaforma no-code AppMaster.io
Le impostazioni API si trovano in diversi punti della nostra piattaforma.
Come creare un endpoint API sulla piattaforma no-code AppMaster.io
Accedere al proprio account per un progetto esistente.
Andare a Data Model Designer. In Data Model Designer verranno visualizzati i modelli con i dati che si desidera elaborare utilizzando gli endpoint API. In ogni progetto, all'inizio, c'è sempre un modello predefinito, l'Utente. Se siete in un nuovo progetto e non avete ancora i vostri modelli, createli.
Assegnare i collegamenti tra i modelli e salvare il progetto.
Andare alla sezione Endpoints nel menu a sinistra della schermata.
Qui si vedrà un elenco di tutti gli endpoint e dei metodi API REST disponibili, collegati a ciascun modello nel campo del progetto. È possibile rimuovere i metodi non necessari e modificare le loro impostazioni (icona dell'ingranaggio e icona del cestino).
Se nell'elenco non c'è un endpoint adatto, è possibile crearne uno nuovo facendo clic sul pulsante Nuovo endpoint e selezionando il tipo appropriato. Si aprirà una finestra modale con le impostazioni dell'endpoint.
Come creare un'API esterna sulla piattaforma no-code AppMaster.io
Andare alla sezione Business Logic nel menu di sinistra.
Qui è possibile creare una richiesta API esterna nella scheda Richiesta API esterna (questa opzione è in beta).
Inoltre, come abbiamo già detto, tutta la documentazione viene generata automaticamente e salvata nel formato OpenAPI (Swagger) nel back end della vostra applicazione.
Swagger è la documentazione e la possibilità di testare tutti gli endpoint direttamente sul posto, senza utilizzare applicazioni di terze parti come Postman.
Conclusione
Come si può vedere, la creazione e la modifica delle impostazioni API utilizzando no-code è molto semplice e richiede un tempo minimo. Se non avete ancora un account su AppMaster.io, unitevi a noi e registratevi per una versione di prova.
