Soumission d'une spécification d'API avec une URL absolue
Saisissez une URL absolue complète vers la spécification.
Éditions requises
| Disponible avec : Lightning Experience |
| Disponible avec : Enterprise Edition, Performance Edition, Unlimited Edition et Developer Edition |
| Autorisations utilisateur requises | |
|---|---|
| Pour gérer les connexions : | Personnaliser l'application |
Important Avant d'utiliser une URL absolue, vous devez ajouter l'URL à vos paramètres Sites distants.
Pour inscrire une spécification d'API en utilisant une URL absolue :
- Vérifiez que l'URL a été ajoutée à vos paramètres Sites distants.
- Dans la Configuration de Lightning Experience, saisissez Services externes dans la case Recherche rapide, puis sélectionnez Services externes.
- Cliquez sur Nouveau service externe.
- Dans la page Sélectionner une source d'API, déterminez si vous importez une spécification d'API Depuis Mulesoft Anypoint Platform ou Depuis la spécification d'API. Comme nous utilisons notre propre spécification dans cet exemple, sélectionnez Depuis la spécification d'API.
- Sous Nom du service externe, saisissez un nom de service unique.
- Sous Description, saisissez une description, facultative. Une description courte et précise aide à différencier un service dans une longue liste de services.
- Cliquez sur sous Sélectionner un identifiant nommé, puis sélectionnez un identifiant nommé dans la liste.
- Sous Schéma du service, sélectionnez URL absolue pour charger et inscrire votre schéma. L'URL doit pointer vers un schéma OpenAPI 2.0 ou 3.0 valide, et conforme JSON ou YAML.
-
Saisissez un chemin d'URL absolue vers le schéma sous URL. Par exemple,
https://my_endpoint.example.com/accountSchema.json. L'URL absolue peut pointer vers un autre domaine que celui spécifié dans Identifiants nommés. - Appuyez sur la touche Entrée ou cliquez hors de la case URL. Le système commence à valider le schéma.
-
Si une ou plusieurs erreurs sont détectées durant le processus de validation, un message (ou une série de messages) affiche des détails spécifiques sur les erreurs. Vous corrigez le schéma en le modifiant directement dans l'éditeur de texte et en cliquant sur Valider pour confirmer vos modifications, ou en modifiant une copie hors ligne et en l'enregistrant de nouveau. Il existe deux types d'erreur :
- Les erreurs de syntaxe ou logiques qui doivent être corrigées pour terminer le processus d’enregistrement. Pour corriger une erreur, consultez le message qui indique son type et son emplacement. Effectuez les modifications requises, puis cliquez sur Valider. Les messages d'erreur de syntaxe indiquent le numéro de ligne et de colonne de l'emplacement.
- Les avertissements syntaxes ou logiques qu’il n'est pas nécessaire de corriger pour effectuer un enregistrement. Cependant, les composants correspondants du schéma sont ignorés par les Services externes et ne sont pas inscrits. Pour résoudre les avertissements, consultez le message, effectuez les modifications requises, puis cliquez sur Valider.
-
Cliquez sur Enregistrer et Suivant.
Remarque Si votre schéma contient des types de média non pris en charge, le système affiche la page Associer des opérations à des types de média pris en charge. Sélectionnez un mappage valide pour chaque type non pris en charge, comme indiqué dans Mappage de types de média lors de l’inscription. - Sélectionnez les opérations que vous souhaitez importer dans l'inscription de votre service externe. Vous pouvez sélectionner jusqu'à 3 000 opérations par organisation et jusqu'à 3 000 objets actifs par organisation. Si vous dépassez l'une de ces limites, répartissez les opérations de votre schéma entre des inscriptions séparées. Pour plus d'informations sur les limites, consultez Considérations relatives aux services externes. Pour plus d'informations sur les « objets » dans les schémas Open API, consultez Basic Structure (OpenAPI 2.0) et Basic Structure (OpenAPI 3.0).
- Cliquez sur Suivant.
- Cliquez sur Terminé.
Cet article a-t-il résolu votre problème ?
Dites-nous ce que nous pouvons améliorer !
