Partilhar via

Modelos de questões na Gestão de APIs do Azure

O Gerenciamento de API do Azure fornece a capacidade de personalizar o conteúdo das páginas do portal do desenvolvedor usando um conjunto de modelos que configuram seu conteúdo. Usando a sintaxe DotLiquid e o editor da sua escolha, como DotLiquid for Designers, assim como um conjunto fornecido de recursos String localizados, recursos Glifo e controlos de Página, você tem grande flexibilidade para configurar o conteúdo das páginas como achar melhor usando esses modelos.

Os modelos nesta seção permitem que você personalize o conteúdo das páginas Problema no portal do desenvolvedor.

Observação

Modelos padrão de exemplo estão incluídos na documentação a seguir, mas estão sujeitos a alterações devido a melhorias contínuas. Você pode visualizar os modelos padrão em tempo real no portal do desenvolvedor navegando até os modelos individuais desejados. Para obter mais informações sobre como trabalhar com modelos, consulte Como personalizar o portal do desenvolvedor do Gerenciamento de API usando modelos.

Observação

O conteúdo da documentação a seguir é sobre o portal do desenvolvedor preterido. Pode continuar a utilizá-lo, como de costume, até à descontinuação em outubro de 2023, altura em que será removido de todos os serviços de gestão de APIs. O portal preterido receberá apenas atualizações de segurança críticas. Veja os seguintes artigos para obter mais detalhes:

APLICA-SE A: Desenvolvedor | Básico | Padrão | Premium

Lista de problemas

O modelo de lista de questões permite personalizar o corpo da página da lista de questões no portal do desenvolvedor.

Lista de Problemas do Portal do Desenvolvedor

Modelo padrão

<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>

Controlos

O modelo Issue list pode usar os seguintes controles de página .

Modelo de dados

Propriedade Tipo Descrição
Issues Recolha de entidades da Emissão . Os problemas visíveis para o usuário atual.
Paging Entidade de Paginação. As informações de paginação para a coleção de aplicativos.
IsAuthenticated Booleano Se o usuário atual está conectado ao portal do desenvolvedor.
CanReportIssues Booleano Se o usuário atual tem permissões para registrar um problema.
Search corda Esta propriedade foi preterida e não deve ser usada.

Dados de exemplo do modelo.

{
    "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
}

Próximos passos

Para obter mais informações sobre como trabalhar com modelos, consulte Como personalizar o portal do desenvolvedor do Gerenciamento de API usando modelos.

  • Last updated on