Vous consultez la documentation Apigee Edge.
Accédez à la
documentation**Apigee X**. info
En tant que fournisseur d'API, vous devez pouvoir exposer vos API, informer les développeurs à leur sujet, les inscrire et leur permettre d'enregistrer des applications. Apigee Edge vous fournit un portail de services dédiés aux 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éveloppement. Pour en savoir plus sur les portails de développeurs, consultez la page Qu'est-ce qu'un portail de 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 de 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 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 d'API en direct. Comme les requêtes d'API proviennent d'un navigateur, la compatibilité CORS (Cross-Origin Resource Sharing) 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 vers le 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 -> SmartDocs proxy URL. 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 direct à l'aide de SmartDocs depuis votre portail échouent.
Communication entre le portail des développeurs et Edge
Le portail des développeurs stocke et récupère la plupart des informations qu'il affiche à partir d'Edge y compris Smartdocs, les développeurs, les produits et les applications de développeurs. Les informations sur l'organisation Edge et les identifiants d'administrateur de développement peuvent être configurés à l'aide de la commande de menu Configuration -> Devportal.
Pour en savoir plus, consultez Communication entre le portail et Edge.