Terminologia di base

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

In Apigee esistono diversi concetti che sono idee comuni con un significato unico.

Termine Definizione
API

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

Definendo punti di contatto stabili e semplificati per la logica e i dati dell'applicazione, le API consentono agli sviluppatori di accedere e riutilizzare facilmente 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 un certo livello di garanzia che, nel tempo, l'API cambierà in modo prevedibile.

Apigee fornisce una vasta gamma di informazioni sulle API e sulle best practice per svilupparle e utilizzarle. Per iniziare, guarda il webcast sul design delle API o scarica l'ebook senza costi Web API Design: The Missing Link Best Practices for Crafting Interfaces that Developers Love.

Proxy API

Una facciata su Edge per una o più API, servizi HTTP generici o applicazioni (ad esempio Node.js).

Un proxy API viene implementato come un insieme di file di configurazione, criteri e codice che si basano su un insieme 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.

La facciata 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 all'edge senza influire sui team di sviluppo interni. Quando 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, liberandoti di dover personalizzare la firma di un'API per soddisfare contemporaneamente le esigenze di varie nicchie di sviluppatori.

Percorso di base dell'API e risorse

API definite da indirizzi di rete e URI. Un'API è composta da un percorso base e da un insieme di risorse API. Ogni proxy API definisce un percorso di base e, facoltativamente, più percorsi delle risorse API. Puoi considerare un'API semplicemente come un insieme di URI, tutti con un percorso di base comune.

Per semplificare la gestione delle API, Apigee integra questi URI non elaborati con nomi e descrizioni visualizzati. Edge ti consente di associare criteri e codice agli URI, consentendo di controllare e gestire in modo granulare il comportamento delle tue API.

Prodotto API

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

Una chiave API è associata a uno o più prodotti API, imponendo 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 come un pacchetto e tipicamente associata a un piano tariffario definito nella monetizzazione.
app

Abbreviazione di applicazione. Il termine app si riferisce alle applicazioni mobile che utilizzano le API. Gli sviluppatori implementano le app in diversi linguaggi di programmazione e 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 segreto che identificano l'app. Lo sviluppatore incorpora la chiave API nell'app, che la presenta quando effettua richieste. I servizi API implementano la sicurezza della chiave API tramite la convalida diretta della chiave API o tramite OAuth.

ambiente

Un contesto di esecuzione del runtime per i proxy API. Un proxy API deve essere dispiegato in un ambiente prima che l'API che espone sia accessibile tramite la rete. Per impostazione predefinita, per le organizzazioni viene eseguito il provisioning di due ambienti: test e prod.

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

Un contenitore per tutti gli oggetti di un account Apigee Edge, inclusi 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à di logica atomica e riutilizzabile all'interno di un flusso di elaborazione del proxy API.

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

Le norme possono essere eseguite 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 della risorsa API Un concetto RESTful, un percorso della 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 è distinto da revisione, ovvero il pacchetto numerato e controllato in base alla versione di configurazione e criteri raggruppati in un proxy API. Le interfacce API hanno versioni; i proxy API hanno revisioni.

revisione Un pacchetto numerato e controllato dalla versione di configurazione e criteri raggruppati in un proxy API. Questo termine è distinto da versione, che è l'interfaccia API rivolta agli sviluppatori. Vedi la versione sopra.