Panoramica del portale Cloud Endpoints

Il portale Cloud Endpoints consente di creare un portale per sviluppatori, un sito web a cui gli utenti della tua API Cloud Endpoints possono accedere per esplorare e testare la tua API. Sul tuo portale, gli sviluppatori che utilizzano l'API nel proprio codice possono trovare la documentazione di riferimento dell'API SmartDocs. SmartDocumenti utilizza il documento OpenAPI che Cloud Endpoints Frameworks crea per generare la documentazione di riferimento dell'API. SmartDocs include un riquadro Prova questa API, in modo che gli sviluppatori possano interagire con la tua API senza uscire dalla documentazione.

portale

Puoi anche fornire la tua documentazione personalizzata per aiutare gli utenti a iniziare e a utilizzare con successo la tua API.

Visita la demo del portale Endpoint per esplorare il portale creato da diversi esempi di endpoint.

Limitazioni

  1. Gli utenti devono eseguire l'autenticazione con un progetto GCP per accedere al portale per gli sviluppatori. Gli utenti non autenticati non possono visualizzare il portale per gli sviluppatori.
  2. Il servizio Endpoints deve essere accessibile pubblicamente per utilizzare il riquadro Prova questa API. Le richieste avranno esito negativo se sul servizio Endpoints è configurata un'altra autenticazione (come IAP).
  3. Il portale degli endpoint non supporta messaggi o servizi con nome identico dichiarati in spazi dei nomi separati di un singolo deployment di endpoint. Questa operazione può interessare gli utenti che tentano di seguire le best practice per il controllo delle versioni dell'API con endpoint. Per evitare il controllo delle versioni non corretto dei messaggi o dei servizi, utilizza uno dei seguenti approcci:
    • Assegna un nome univoco a tutti i messaggi e i servizi di tutti i file .proto. Ad esempio, assegna un nome al messaggio data data1 nella versione 1, data2 nella versione 2 e così via.
    • Separa le versioni API in diversi deployment degli endpoint.

Passaggi successivi