Vous consultez la documentation d'Apigee Edge.
Accédez à la documentation sur Apigee X. info
En tant que fournisseur d'API, vous devez disposer d'un moyen d'exposer vos API, de les présenter aux développeurs, de les inscrire et de leur permettre d'enregistrer des applications. Apigee Edge vous fournit un portail de services pour les développeurs que vous pouvez utiliser pour créer et lancer votre propre site Web personnalisé afin de fournir ces services à votre communauté de développeurs. Pour en savoir plus sur les portails des développeurs, consultez la page 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 pour les développeurs.
Fonctionnement des SmartDocs
Vous pouvez importer une spécification OpenAPI (JSON ou YAML) ou WADL décrivant votre API dans SmartDocs et l'utiliser 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 sous l'onglet "API" de votre portail. Les développeurs découvrent la documentation de l'API via le portail et peuvent effectuer des requêtes API en direct. Étant donné que les requêtes d'API proviennent d'un navigateur, la compatibilité avec le partage de ressources entre origines multiples (CORS) est nécessaire pour qu'elles aboutissent. La compatibilité CORS est fournie par le proxy "smartdocs" sur Edge (dans l'organisation "VALIDATE") qui sert de proxy pour toutes les requêtes SmartDocs au point de terminaison prévu. Le proxy "smartdocs" est créé lorsque vous installez SmartDocs.
Exemple :
L'URL du proxy SmartDocs est exposée en tant que propriété configurable dans 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 d'API en temps réel utilisant SmartDocs à partir de votre portail échouent.
Comment le portail des développeurs communique-t-il avec Edge ?
Le portail des développeurs stocke et récupère la plupart des informations qu'il affiche à partir d'Edge, y compris les Smartdocs, les développeurs, les produits et les applications des développeurs. Les informations sur l'organisation Edge et les identifiants de l'administrateur de développement sont configurables à l'aide de la commande de menu "Configuration -> Devportal".
Pour en savoir plus, consultez la section Communiquer entre le portail et Edge.