Questa pagina si applica ad Apigee e Apigee hybrid.
Visualizza la documentazione di
Apigee Edge.
Nella fase di progettazione, definisci i requisiti per l'API. In qualità di designer di API, pianifichi i servizi che vuoi esporre ai consumer e progetti le API per l'accesso a questi servizi. Creerai uno dei seguenti documenti per acquisire i requisiti dell'API:
- 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 delle due opzioni di progettazione delle API, vedi REST e GraphQL a confronto in questo post del blog.
Che cos'è la specifica OpenAPI?
"OpenAPI Initiative (OAI) è incentrata sulla creazione, sull'evoluzione e sulla promozione di un formato di descrizione dell'API indipendente dal fornitore e 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 di facile lettura e comprensione per gli esseri umani. La specifica OpenAPI consente una descrizione formale degli elementi di un'API, come percorso base, percorsi e verbi, intestazioni, parametri di ricerca, tipi di contenuti, modelli di risposta e altro ancora. Inoltre, un documento OpenAPI è comunemente utilizzato per generare documentazione API.
Ecco un frammento di un documento OpenAPI che descrive il semplice esempio di hello world di Apigee. Per maggiori informazioni, visualizza 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 fonti di informazioni eccellenti sulle specifiche OpenAPI. Un buon punto di partenza è il sito 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.
Sono disponibili numerosi documenti OpenAPI di esempio JSON e YAML che puoi scaricare dal repository delle specifiche OpenAPI.
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 di sovraccaricare o recuperare i dati in modo insufficiente.
- L'elaborazione delle query avviene in parallelo
Per ulteriori informazioni su GraphQL, vedi graphql.org.
Di seguito è riportato un esempio di uno schema GraphQL che definisce il punto di ingresso 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 per 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.
L'eliminazione o la modifica di un documento ha conseguenze negative in termini di durata:
- Se modifichi un documento, devi modificare manualmente gli artefatti correlati, tra cui il proxy API e gli eventuali prodotti API che espongono le relative risorse, quindi rigenerare la documentazione di riferimento dell'API per riflettere le modifiche implementate nel documento.
- Se elimini un documento, dovrai eliminare manualmente gli artefatti correlati, incluso il proxy API, e modificare i prodotti API per eliminare le risorse correlate, quindi rigenerare la documentazione di riferimento dell'API in modo che rifletta la rimozione del documento e delle relative risorse.
Che cosa succede quando creo un proxy API da un documento OpenAPI?
Puoi creare proxy API dai tuoi documenti OpenAPI. Con pochi clic potrai disporre di un proxy API con percorsi, parametri, flussi condizionali ed endpoint di destinazione generati automaticamente. Successivamente, puoi aggiungere funzionalità quali 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 di creazione del proxy, come descritto in Utilizzo delle 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 un'istantanea del documento OpenAPI per generare la documentazione di riferimento dell'API. L'istantanea rappresenta una revisione specifica del documento descrittivo.