Vous consultez la documentation d'Apigee Edge.
Consultez la
documentation Apigee X. en savoir plus
En tant que fournisseur d'API, vous avez besoin d'un moyen d'exposer vos API, d'informer les développeurs sur vos API, d'inscrire des développeurs et de permettre aux développeurs d'enregistrer des applications. Apigee Edge met à votre disposition un portail de services pour les développeurs qui vous permet de créer et de lancer votre propre site Web personnalisé afin de fournir ces services à votre communauté de développeurs. Pour en savoir plus sur les portails de développeurs, consultez la section Qu'est-ce qu'un portail des développeurs ?
Les sections suivantes décrivent les concepts clés que vous devez comprendre avant de résoudre les problèmes liés à votre portail des développeurs.
Fonctionnement de SmartDocs
Une spécification OpenAPI (JSON ou YAML) ou WADL décrivant votre API peut être importée dans SmartDocs et utilisée pour publier la documentation de référence de l'API sur votre portail. La documentation de référence de l'API s'affiche automatiquement dans l'onglet "API" de votre portail. Les développeurs découvrent la documentation de l'API sur le portail et peuvent envoyer des requêtes API en direct. Étant donné que les requêtes API proviennent d'un navigateur, la compatibilité CORS (Cross-Origin Resource Sharing) est nécessaire pour qu'elles aboutissent. La compatibilité CORS est assurée par le proxy "smartdocs" sur Edge (dans l'organisation "VALIDATE") qui agit comme proxy pour toutes les requêtes SmartDocs adressées au point de terminaison prévu. Le proxy "smartdocs" est créé lorsque vous installez SmartDocs.
Exemple :
L'URL du proxy smartdocs est présentée sous la forme d'une propriété configurable sous Configuration -> SmartDocs -> URL du proxy SmartDocs. Vous devrez peut-être modifier cette URL si votre API se trouve sur un réseau privé et que les requêtes API actives à l'aide de SmartDocs depuis votre portail échouent.
Comment le portail des développeurs communique avec Edge
Le portail des développeurs stocke et récupère la plupart des informations qu'il affiche depuis Edge, y compris Smartdocs, les développeurs, les produits et les applications pour développeurs. Vous pouvez configurer les informations sur l'organisation Edge et les identifiants devadmin à l'aide de la commande de menu Configuration -> Devportal.
Pour plus d'informations, consultez la section Communication entre le portail et Edge.