Accéder au contenu principal Passer au contenu complémentaire

Gérer votre documentation d'API

Publiez, mettez à jour et annulez la publication de votre documentation d'API.

Pourquoi et quand exécuter cette tâche

Depuis la liste des API dans l'onglet API Portal, vous pouvez gérer la documentation d'API publiée dans votre dépôt.
Onglet API Portal.

Procédure

  • Pour publier une nouvelle version de votre API dans votre portail, cliquez sur le bouton Publish.
  • Pour publier à nouveau la même documentation, cliquez sur le bouton Republish.
  • Si une API a été modifiée depuis sa dernière publication, cliquez sur le bouton Update pour envoyer la documentation mise à jour dans votre dépôt.
    Si les dernières modifications ont été publiées, cette icône s'affiche près de la date de la dernière mise à jour : icône Up to date (À jour). Si la définition d'API a été mise à jour depuis la dernière publication, cette icône s'affiche : icône Not up to date (Pas à jour).
  • Pour supprimer une version d'API de votre dépôt, cliquez sur Unpublish.
  • Pour marquer une version d'API comme publiée, sans effectuer de push vers votre dépôt, cliquez sur le bouton Menu et sur Mark as published (Marquer comme publiée).
  • Pour marquer une version d'API comme publication annulée, sans supprimer la documentation de votre dépôt, cliquez sur le bouton Menu et sur Mark as unpublished (Marquer comme publication annulée).

Cette page vous a-t-elle aidé ?

Si vous rencontrez des problèmes sur cette page ou dans son contenu – une faute de frappe, une étape manquante ou une erreur technique – dites-nous comment nous améliorer !