Stai visualizzando la documentazione di Apigee Edge.
Vai alla
documentazione di Apigee X. informazioni
In qualità di provider di API, hai bisogno di un modo per esporre le tue API, informare gli sviluppatori sulle tue API, registrare gli sviluppatori e consentire agli sviluppatori di registrare le app. Apigee Edge fornisce un portale Servizi per gli sviluppatori che puoi utilizzare per creare e lanciare il tuo sito web personalizzato al fine di fornire questi servizi alla tua community di sviluppo. Per scoprire di più sui portali per gli sviluppatori, consulta l'articolo Che cos'è un portale per gli sviluppatori?
Le seguenti sezioni descrivono i concetti chiave da comprendere prima di risolvere i problemi relativi al portale per gli sviluppatori.
Come funziona SmartDocumenti
Una specifica OpenAPI (JSON o YAML) o WADL che descrive l'API può essere importata in SmartDocumenti e utilizzata per pubblicare la documentazione di riferimento dell'API sul tuo portale. La documentazione di riferimento delle API viene visualizzata automaticamente nella scheda API del tuo portale. Gli sviluppatori scoprono la documentazione relativa alle API tramite il portale e possono effettuare richieste API in tempo reale. Poiché le richieste API provengono da un browser, è necessario il supporto della condivisione delle risorse tra origini (CORS) per garantirne la riuscita. Il supporto di CORS è fornito dal proxy "smartdocs" su Edge (nell'organizzazione "VALIDATE") che agisce da proxy per tutte le richieste SmartDocumenti all'endpoint previsto. Il proxy "smartdocs" viene creato quando installi SmartDocumenti.
Ad esempio:
L'URL del proxy Smartdocs viene mostrato come proprietà configurabile in Configurazione -> SmartDocumenti -> URL del proxy SmartDocumenti. Potrebbe essere necessario modificare questo URL se l'API si trova su una rete privata e le richieste API in tempo reale mediante SmartDocumenti dal tuo portale non riescono.
Comunicazione del Portale per gli sviluppatori con Edge
Il portale per gli sviluppatori archivia e recupera la maggior parte delle informazioni visualizzate da Edge, tra cui Smartdocs, sviluppatori, prodotti e app per sviluppatori. Le informazioni sull'organizzazione perimetrale e le credenziali devadmin sono configurabili utilizzando il comando di menu Configurazione -> Devportal.
Per maggiori informazioni, consulta la pagina relativa alla comunicazione tra il portale ed Edge.