Stai visualizzando la documentazione di Apigee Edge.
Consulta la
documentazione di Apigee X. info
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 loro di registrare le app. Apigee Edge ti fornisce un portale Developer Services che puoi utilizzare per creare e lanciare il tuo sito web personalizzato per fornire questi servizi alla tua community di sviluppo. Per saperne di più sui portali per sviluppatori, consulta Che cos'è un portale per sviluppatori?
Le sezioni seguenti descrivono i concetti chiave che devi comprendere prima di risolvere i problemi relativi al portale per sviluppatori.
Come funziona SmartDocs
Una specifica OpenAPI (JSON o YAML) o WADL che descrive la tua API può essere importata in SmartDocs e utilizzata per pubblicare la documentazione di riferimento dell'API sul tuo portale. La documentazione di riferimento dell'API viene visualizzata automaticamente nella scheda API del portale. Gli sviluppatori scoprono la documentazione dell'API tramite il portale e possono effettuare richieste API in tempo reale. Poiché le richieste API provengono da un browser, è necessario il supporto CORS (Cross-Origin Resource Sharing) per consentire il completamento delle richieste. Il supporto CORS è fornito dal proxy "smartdocs" su Edge (nell'organizzazione "VALIDATE") che funge da proxy per tutte le richieste SmartDocs all'endpoint previsto. Il proxy "smartdocs" viene creato quando installi SmartDocs.
Ad esempio:
L'URL del proxy smartdocs viene esposto come proprietà configurabile in Configurazione -> SmartDocs -> URL del proxy SmartDocs. Potresti dover modificare questo URL se la tua API si trova su una rete privata e le richieste API in tempo reale che utilizzano SmartDocs dal tuo portale non vanno a buon fine.
In che modo il portale per sviluppatori comunica con Edge
Il portale per sviluppatori archivia e recupera la maggior parte delle informazioni che visualizza da Edge inclusi SmartDocs, sviluppatori, prodotti e app per sviluppatori. Le informazioni sull'organizzazione Edge e le credenziali devadmin sono configurabili utilizzando il comando di menu Configurazione -> Portale per sviluppatori.
Per ulteriori informazioni, consulta Comunicazione tra il portale e Edge.