Terminologia di base

Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X.
informazioni

Esistono diversi concetti comuni con un significato unico in Apigee.

Termine Definizione
API

Un'interfaccia di programmazione di un'applicazione, ovvero un'interfaccia che consente a un'applicazione di consumare facilmente funzionalità o dati di un'altra applicazione.

Definindo punti di ingresso stabili e semplificati per la logica e i dati dell'applicazione, le API consentono agli sviluppatori di accedere facilmente e di riutilizzare la logica dell'applicazione creata da altri sviluppatori. Nel caso delle API web, la logica e i dati vengono esposti sulla rete. Poiché le applicazioni che utilizzano le API sono sensibili alle modifiche, le API implicano anche un contratto. Il contratto fornisce una certa garanzia che, nel tempo, l'API cambierà in modo prevedibile.

Apigee offre un'ampia gamma di informazioni sulle API e best practice per svilupparle e utilizzarle. Per iniziare, consulta il webcast API Design o scarica l'ebook senza costi Web API Design: The Missing Link Best Practices for Crafting Interfaces that Developers Love.

Proxy API

Un facade su Edge per una o più API, servizi HTTP generici o applicazioni (come Node.js).

Un proxy API viene implementato come insieme di file di configurazione, criteri e codice che si basa su un set di risorse fornite da Apigee Edge. I proxy API possono essere generati e configurati utilizzando l'interfaccia utente di gestione di Apigee Edge oppure possono essere implementati localmente in un editor di testo o in un IDE.

L'interfaccia fornita da un proxy API disaccoppia l'API rivolta agli sviluppatori dai servizi di backend, proteggendo gli sviluppatori dalle modifiche al codice e consentendo l'innovazione a livello perimetrale senza influire sui team di sviluppo interni. Mentre i team di sviluppo apportano modifiche al backend, gli sviluppatori continuano a chiamare la stessa interfaccia senza interruzioni. Apigee ti consente di esporre più interfacce alla stessa API, lasciandoti la possibilità di personalizzare la firma di un'API per soddisfare le esigenze di varie nicchie di sviluppatori contemporaneamente.

Percorso e risorse di base dell'API

API definite da indirizzi di rete e URI. Un'API è composta da un percorso di base e da un insieme di risorse API. Ogni proxy API definisce un percorso di base e, facoltativamente, più percorsi delle risorse API. Un'API può essere paragonata a un insieme di URI, tutti condividono un percorso di base comune.

Per semplificare la gestione delle API, Apigee aumenta questi URI non elaborati con nomi visualizzati e descrizioni. Edge consente di collegare criteri e codice agli URI, consentendo un controllo e una gestione granulari del comportamento delle API.

Prodotto API

Una raccolta di risorse API (URI) combinate con una quota, o piano di servizio, che viene pubblicata per gli sviluppatori di app in fase di progettazione. I prodotti basati su API possono a loro volta essere raggruppati in pacchetti API per la monetizzazione.

Una chiave API è associata a uno o più prodotti API, applicando un'associazione tra un'app e il bundle di URI che l'app è autorizzata a utilizzare.

Pacchetto API Una raccolta di prodotti API presentati agli sviluppatori sotto forma di bundle e generalmente associati a un piano tariffario definito nella monetizzazione.
l'app

Un'abbreviazione di application. Il termine app si riferisce alle applicazioni per dispositivi mobili che utilizzano le API. Gli sviluppatori implementano le app in una varietà di linguaggi di programmazione, nonché utilizzando varie tecnologie e piattaforme. Gli sviluppatori che vogliono utilizzare le API registrano le app nell'organizzazione di un provider di API su Apigee Edge.

Quando l'app è registrata, Apigee genera una chiave API e un secret che identificano l'app. Lo sviluppatore incorpora la chiave API nell'app, che presenta la chiave quando effettua le richieste. I servizi API implementano la sicurezza della chiave API mediante la convalida diretta della chiave API o tramite OAuth.

ambiente

Un contesto di esecuzione di runtime per i proxy API. È necessario eseguire il deployment di un proxy API in un ambiente prima che l'API che espone sia accessibile sulla rete. Per impostazione predefinita, le organizzazioni vengono sottoposte a provisioning con due ambienti: test e prod.

  • L'ambiente di test viene in genere utilizzato per il deployment dei proxy API durante lo sviluppo.
  • L'ambiente di prod viene in genere utilizzato per promuovere i proxy API dall'ambiente di test dopo che sono stati completamente sviluppati e testati.
organizzazione

Un container per tutti gli oggetti in un account Apigee Edge, tra cui proxy API, prodotti API, pacchetti API, app e sviluppatori.

È necessario un account utente per ogni organizzazione di cui sei membro. La maggior parte degli utenti avrà un account in una sola organizzazione.

norme

Un passaggio di elaborazione che viene eseguito come unità logica atomica e riutilizzabile all'interno di un flusso di elaborazione proxy API.

Le tipiche funzionalità basate su criteri includono la trasformazione dei formati dei messaggi, l'applicazione del controllo dell'accesso, la chiamata a servizi remoti per ulteriori informazioni, il mascheramento dei dati sensibili degli utenti esterni, l'esame dei contenuti dei messaggi per individuare potenziali minacce, la memorizzazione nella cache delle risposte comuni per migliorare le prestazioni e così via.

I criteri possono essere eseguiti in modo condizionale in base ai contenuti o al contesto di una richiesta o di un messaggio di risposta. Ad esempio, è possibile eseguire un criterio di trasformazione per personalizzare un formato di risposta se il messaggio di richiesta è stato inviato da uno smartphone.

Percorso risorsa API In un concetto RESTful, un percorso risorsa è un URI (Uniform Resource Identifier) che identifica il percorso di rete di una determinata risorsa.
Versione

La versione dell'interfaccia API rivolta agli sviluppatori.

Ad esempio, pivotaltracker.com/services/v3 o api.enterprise.apigee.com/v1.

Questo termine si distingue dalla revisione, che è il pacchetto numerato e controllato a livello di versione di configurazione e criteri integrato in un proxy API. Le interfacce API hanno versioni e i proxy API hanno revisioni.

revisione Un pacchetto numerato e controllato a livello di versione di configurazione e criteri integrato in un proxy API. Questo termine si distingue dalla versione, che è l'interfaccia API rivolta agli sviluppatori. Vedi la versione sopra.