Collezione Postman per funzionalità di gestione API

4 lettura minima
Riassumere questo con l'AI

Con l'ampliarsi dell'utilizzo della funzionalità di gestione delle API di SnapLogic, sempre più aziende e organizzazioni stanno scoprendo che il portale API è uno strumento utile non solo per pubblicare le API create all'interno della piattaforma, ma anche per pubblicare e creare il proprio catalogo di API esterne o proxy nel proprio ecosistema. In particolare, nelle organizzazioni che hanno sviluppato microservizi a supporto delle loro iniziative prima di adottare una piattaforma di integrazione, non tutti i creatori di API sono necessariamente integratori SnapLogic. Questi microservizi esterni o servizi di terze parti e le API di integrazione sviluppate con le pipeline SnapLogic hanno in comune un intero ciclo di vita, tipicamente supportato da procedure, strumenti e automazioni DevOps. 

Prendiamo ad esempio un microservizio legacy che potrebbe controllare il motore passo-passo di una telecamera di sicurezza. Non si tratta specificatamente di un'app o di un servizio di integrazione dati, ma espone un'API per inviare un segnale a un dispositivo. SnapLogic può gestire facilmente l'API di quel microservizio come proxy all'interno di APIM, e gli integratori possono scoprire e conoscere quell'API all'interno del catalogo. Se il produttore dovesse aggiornare il firmware della telecamera e fornire un'API aggiornata da utilizzare, con le API APIM pubbliche di SnapLogic, il team DevOps potrebbe scrivere uno script per aggiornare il firmware di ciascun dispositivo e allo stesso tempo gestire la documentazione e la definizione dell'API all'interno di SnapLogic APIM. Senza queste API, il team di implementazione potrebbe dover sostenere i costi aggiuntivi legati al coordinamento manuale dell'aggiornamento della definizione dell'API.

Le API disponibili offrono anche funzionalità per migrare sia le API SnapLogic che le API proxy. Se il team di integrazione collabora con un team DevOps per spostare elementi dall'ambiente di sviluppo a quello di test e poi a quello di produzione, o magari da una regione all'altra, le API pubbliche rendono questa operazione facile e veloce.

Per facilitare l'apprendimento delle API pubbliche e consentire ai team di testarle, abbiamo creato una raccolta di API pubbliche allegata a questo post. Ogni esempio è completamente parametrizzato e accompagnato da un ambiente Postman. Caricando un'API in Postman e configurando l'ambiente corrispondente, gli integratori o gli ingegneri possono creare rapidamente esempi da utilizzare nella propria organizzazione.

Installazione

Il file allegato può essere decompresso su una workstation personale e un utente Postman può creare un nuovo spazio di lavoro. In tale spazio di lavoro sarà presente un pulsante di importazione che consentirà all'utente di selezionare la raccolta e tutti gli ambienti in un colpo solo.

Immagine 1: Posizione del pulsante Importa
Immagine 2: Selezione dei file da importare

Una volta completata l'operazione, sia la raccolta di API che gli ambienti saranno disponibili dalla barra di navigazione a sinistra. 

Immagine 3: API di esempio caricate nelle raccolte
Immagine 4: Variabili ambientali caricate su Postman

Preparazione

Una volta caricati gli ambienti, è necessario creare e configurare un ambiente globale per l'intera raccolta.Aggiungi quanto segue al tuo ambiente globalePostman :

  • utente (utente amministrativo IIP)

  • password (utente amministrativo IIP)

  • pod_path (dominio – in genere elastic.snaplogic.com per il Nord America)

  • ambiente (quello che una volta era il nome dell'organizzazione nell'URL per IIP)

Una volta configurato, il tuo ambiente globale apparirà simile all'immagine sottostante.

Immagine 5: Variabili globali configurate.

Utilizzo della collezione

Una volta configurato l'ambiente globale, resta da configurare i valori nell'ambiente per l'API specifica da testare, quindi aprire l'API e impostare il suo ambiente su quello appena configurato.

Ad esempio, un integratore potrebbe già disporre di una serie di pipeline SnapLogic in un progetto che sono destinate ad essere disponibili come API in APIM per l'utilizzo in tutta l'organizzazione. Il primo passo in questo processo è quello di compilare le variabili per il proprio progetto nell'ambiente Postman appropriato. Nella raccolta allegata a questo post, ogni richiesta nella raccolta avrà un ambiente corrispondente. Per la richiesta Crea APIM da progetto SL, l'ambiente corrispondente è chiamato anch'essoCrea APIM da progetto SL

Immagine 6: Le variabili nell'ambiente saranno utilizzate nella richiesta con lo stesso nome.

Una volta configurate le variabili nell'ambiente, prima di testare l'API specificata, assicurarsi che l'ambiente configurato sia applicato alla richiesta. Ciò è possibile utilizzando il selettore sulla richiesta nell'angolo in alto a destra.

Immagine 7: Applicazione dell'ambiente alla richiesta.

Una volta configurato l'ambiente e applicato alla richiesta, è possibile utilizzare il pulsante "Invia" per eseguire la richiesta. Questa raccolta può essere utilizzata ora sia per testare l'API pubblica, sia dagli integratori che possono utilizzare le configurazioni variabili per aiutare i loro team DevOps a sviluppare al meglio le loro automazioni per la gestione dei loro microservizi legacy insieme alle API SnapLogic modernizzate. 

SnapLogic è la società di integrazione agenziale.
Categoria: Tecnica
All'interno della piattaforma: Approfondimenti tecnici degli esperti SnapLogic

Scoprite SnapLogic in azione con un tour interattivo!

Immagine dimostrativa del tour interattivo