Modèles de problème dans Gestion des API Azure

2019-11-04

Gestion des API Azure vous offre la possibilité de personnaliser le contenu des pages du portail des développeurs à l’aide d’un ensemble de modèles qui configurent leur contenu. À l’aide de la syntaxe Dot Liquid et de l’éditeur de votre choix, tels que Dot Liquidité pour les concepteurs, ainsi qu’un ensemble fourni de ressources string localisées, de ressources Glyphe et de contrôles Page, vous avez une grande flexibilité pour configurer le contenu des pages comme vous le voyez à l’aide de ces modèles.

Les modèles de cette section vous permettent de personnaliser le contenu des pages Problèmes dans le portail des développeurs.

Liste des problèmes

Remarque

Les exemples de modèles par défaut inclus dans la documentation suivante sont susceptibles d’être modifiés et améliorés de façon régulière. Vous pouvez afficher les modèles dynamiques par défaut dans le portail des développeurs en accédant aux modèles individuels souhaités. Pour plus d’informations sur l’utilisation de modèles, consultez Comment personnaliser le portail des développeurs Gestion des API à l’aide de modèles.

Remarque

Le contenu de la documentation suivante s’applique au portail des développeurs déconseillé. Vous pouvez continuer à l’utiliser normalement jusqu’à sa suppression en octobre 2023, lorsqu’il sera supprimé de tous les services de gestion des API. Le portail obsolète recevra uniquement les mises à jour de sécurité critiques. Pour plus d’informations, reportez-vous aux articles suivants :

S’APPLIQUE À : Développeur | De base | Standard | Prime

Liste des problèmes

Le modèle de liste des problèmes vous permet de personnaliser le corps de la page de liste des problèmes dans le portail des développeurs.

Liste des problèmes Portail des développeurs

Modèle par défaut

<div class="row">
  <div class="col-md-9">
    <h2>{% localized "IssuesStrings|WebIssuesIndexTitle" %}</h2>
  </div>
</div>
<div class="row">
  <div class="col-md-12">
    {% if issues.size > 0 %}
    <ul class="list-unstyled">
      {% capture reportedBy %}{% localized "IssuesStrings|WebIssuesStatusReportedBy" %}{% endcapture %}
      {% assign replaceString0 = '{0}' %}
      {% assign replaceString1 = '{1}' %}
      {% for issue in issues %}
      <li>
        <h3>
          <a href="/issues/{{issue.id}}">{{issue.title}}</a>
        </h3>
        <p>{{issue.description}}</p>
        <em>
          {% capture state %}{{issue.issueState}}{% endcapture %}
          {% capture devName %}{{issue.subscriptionDeveloperName}}{% endcapture %}
          {% capture str1 %}{{ reportedBy | replace : replaceString0, state }}{% endcapture %}
          {{ str1 | replace : replaceString1, devName }}
          <span class="UtcDateElement">{{ issue.reportedOn | date: "r" }}</span>
        </em>
      </li>
      {% endfor %}
    </ul>
    <paging-control></paging-control>
    {% else %}
    {% localized "CommonResources|NoItemsToDisplay" %}
    {% endif %}
    {% if canReportIssue %}
    <a class="btn btn-primary" id="createIssue" href="/Issues/Create">{% localized "IssuesStrings|WebIssuesReportIssueButton" %}</a>
    {% elsif isAuthenticated %}
    <hr />
    <p>{% localized "IssuesStrings|WebIssuesNoActiveSubscriptions" %}</p>
    {% else %}
    <hr />
    <p>
      {% capture signIntext %}{% localized "IssuesStrings|WebIssuesNotSignin" %}{% endcapture %}
      {% capture link %}<a href="/signin">{% localized "IssuesStrings|WebIssuesSignIn" %}</a>{% endcapture %}
      {{ signIntext | replace : replaceString0, link }}
    </p>
    {% endif %}
  </div>
</div>

Contrôles

Le Issue list modèle peut utiliser les contrôles de page suivants.

contrôle de pagination

Modèle de données

Propriété	Catégorie	Descriptif
`Issues`	Collection d’entités de problème .	Problèmes visibles par l’utilisateur actuel.
`Paging`	Entité de pagination.	Informations relatives à la pagination de la collection d’applications.
`IsAuthenticated`	booléen	Indique si l’utilisateur actuel est connecté au portail des développeurs.
`CanReportIssues`	booléen	Indique si l’utilisateur actuel dispose des autorisations nécessaires pour émettre un problème.
`Search`	ficelle	Cette propriété est déconseillée et ne doit pas être utilisée.

Données d’un exemple de modèle

{
    "Issues": [
        {
            "Id": "5702b68bb16653124c8f9ba7",
            "ApiId": "570275f1b16653124c8f9ba3",
            "Title": "I couldn't figure out how to connect my application to the API",
            "Description": "I'm having trouble connecting my application to the backend API.",
            "SubscriptionDeveloperName": "Clayton",
            "IssueState": "Proposed",
            "ReportedOn": "2016-04-04T18:46:35.64",
            "Comments": null,
            "Attachments": null,
            "Services": null
        }
    ],
    "Paging": {
        "Page": 1,
        "PageSize": 10,
        "TotalItemCount": 1,
        "ShowAll": false,
        "PageCount": 1
    },
    "IsAuthenticated": true,
    "CanReportIssue": true,
    "Search": null
}

Étapes suivantes

Pour plus d’informations sur l’utilisation de modèles, consultez Comment personnaliser le portail des développeurs Gestion des API à l’aide de modèles.

Partager via