Questa pagina si applica ad Apigee e Apigee hybrid.
Visualizza la documentazione di
Apigee Edge.
Nella fase di progettazione, definisci i requisiti per la tua API. In qualità di progettista di API, pianifichi i servizi che vuoi esporre ai consumatori e progetti le API per accedere a questi servizi. Per acquisire i requisiti dell'API, crea uno dei seguenti documenti:
- Un documento OpenAPI
- Uno schema GraphQL
Le sezioni seguenti forniscono ulteriori informazioni sui documenti OpenAPI e GraphQL e sul loro ruolo nel ciclo di vita dell'API. Per un confronto tra le due opzioni di progettazione delle API, consulta il confronto tra REST e GraphQL in questo post del blog.
Che cos'è la specifica OpenAPI?
"L'OpenAPI Initiative (OAI) si concentra sulla creazione, sull'evoluzione e sulla promozione di un formato di descrizione API indipendente dal fornitore basato sulla specifica Swagger." Per ulteriori informazioni sull'iniziativa OpenAPI, visita il sito https://openapis.org.
Un documento OpenAPI utilizza un formato standard per descrivere un'API RESTful. Scritto in formato JSON o YAML, un documento OpenAPI è leggibile dalle macchine, ma anche facile da leggere e comprendere da parte degli utenti. La specifica OpenAPI consente la descrizione formale degli elementi di un'API, come il percorso di base, i percorsi e i verbi, le intestazioni, parametri di ricerca, i tipi di contenuti, i modelli di risposta e altro ancora. Inoltre, un documento OpenAPI viene comunemente utilizzato per generare la documentazione dell'API.
Di seguito è riportato un frammento di un documento OpenAPI che descrive il semplice esempio di Hello World di Apigee. Per ulteriori informazioni, consulta la specifica OpenAPI su GitHub.
openapi: 3.0.0
info:
description: OpenAPI Specification for the Apigee mock target service endpoint.
version: 1.0.0
title: Mock Target API
paths:
/:
get:
summary: View personalized greeting
operationId: View a personalized greeting
description: View a personalized greeting for the specified or guest user.
parameters:
- name: user
in: query
description: Your user name.
required: false
schema:
type: string
responses:
"200":
description: Success
/help:
get:
summary: Get help
operationId: Get help
description: View help information about available resources in HTML format.
responses:
"200":
description: Success
...
Esistono molte ottime fonti di informazioni sulle specifiche OpenAPI. Un buon punto di partenza è il sito dell'OpenAPI Initiative, dove troverai panoramiche, blog e link alla specifica OpenAPI. Per descrizioni dettagliate degli elementi dello schema e dei tipi di dati, consulta la specifica.
Esistono diversi documenti OpenAPI di esempio JSON e YAML che puoi scaricare dal repository della specifica OpenAPI.
Che cos'è uno schema GraphQL?
Uno schema GraphQL descrive i dati disponibili nella tua API su cui un client può eseguire query.
I vantaggi dell'utilizzo di GraphQL includono:
- Un singolo endpoint fornisce l'accesso a tutti i campi per una determinata operazione
- Il potente linguaggio di query, chiamato Schema Definition Language, ti consente di accedere esattamente ai dati di cui hai bisogno, evitando il recupero eccessivo o insufficiente dei dati.
- L'elaborazione delle query avviene in parallelo
Per ulteriori informazioni su GraphQL, visita il sito graphql.org.
Di seguito è riportato un esempio di schema GraphQL che definisce il punto di inserimento dei dati (tipo di query), le operazioni di scrittura disponibili (tipo di mutazione) e i tipi di dati.
type Query {
Greeting: String
students: [Student]
}
type Mutation {
createStudent(firstName: String!, lastName: String!): Student!
}
type Subscription {
newStudent: Student!
}
type Student {
Id: ID!
firstName: String!
lastName: String!
password: String!
collegeId: String!
}
Puoi eseguire query sullo schema GraphQL per restituire i dati esatti di cui hai bisogno come payload JSON.
Che cosa succede se modifico un documento?
Ogni documento OpenAPI o GraphQL funge da fonte attendibile durante tutto il ciclo di vita dell'API. Lo stesso documento viene utilizzato in ogni fase del ciclo di vita dell'API, dallo sviluppo alla pubblicazione fino al monitoraggio.
La modifica o l'eliminazione di un documento ha un impatto a cascata:
- Se modifichi un documento, devi modificare manualmente gli elementi correlati, tra cui il proxy API e tutti i prodotti API che espongono le relative risorse, e rigenerare la documentazione di riferimento dell'API in modo che rifletta le modifiche implementate nel documento.
- Se elimini un documento, devi eliminare manualmente gli elementi correlati, tra cui il proxy API, modificare eventuali prodotti API per eliminare le risorse correlate e rigenerare la documentazione di riferimento dell'API in modo che rifletta la rimozione del documento e delle relative risorse.
Cosa succede quando creo un proxy API da un documento OpenAPI?
Puoi creare i proxy API dai documenti OpenAPI. Con pochi clic, avrai un proxy API con percorsi, parametri, flussi condizionali ed endpoint di destinazione generati automaticamente. Successivamente, puoi aggiungere funzionalità come la sicurezza OAuth, la limitazione di frequenza e la memorizzazione nella cache.
Puoi creare un proxy API da un documento OpenAPI utilizzando la procedura guidata Crea proxy, come descritto in Utilizzare le specifiche OpenAPI per generare proxy. Per un'esperienza pratica, segui il tutorial Creazione di un proxy API da una specifica OpenAPI.
Quando pubblichi l'API, acquisisci uno snapshot del documento OpenAPI per generare la documentazione di riferimento dell'API. Questa istantanea rappresenta una revisione specifica del documento descrittivo.