Compartilhar via

Estrutura de documentação da API REST do Fabric

As APIs REST do Microsoft Fabric foram projetadas para ajudar os desenvolvedores a automatizar o Fabric. As páginas de referência da API REST do Fabric (documentação) são estruturadas para ajudar os desenvolvedores a encontrar as informações necessárias.

As páginas de referência são divididas em duas seções principais:

  • APIs principais – As APIs principais fornecem informações e funcionalidades para todos os itens no Microsoft Fabric. As APIs principais não são específicas para uma carga de trabalho e podem ser usadas em todas as cargas de trabalho. As APIs principais são APIs CRUD (Criar, Ler, Atualizar e Excluir). Você pode usá-los para criar ou atualizar itens do Fabric junto com suas propriedades comuns. As APIs principais podem ser usadas durante a execução de operações em lote que não forçam a manipulação de nenhuma propriedade específica a um tipo de item específico.

  • APIs de carga de trabalho – AS APIs de carga de trabalho destinam-se a um tipo de item específico no Fabric.

As seções de página de referência de núcleo e carga de trabalho listam todas as APIs em ordem alfabética. Cada seção contém uma visão geral que inclui uma lista de todas as APIs na seção e uma lista alfabética das APIs na seção.

Registro específico do item

A seção específica do item detalha as especificidades de cada tipo de item no Fabric. Cada entrada de tipo de item contém:

  • Visão geral: uma breve descrição do tipo de item.

  • Pontos de extremidade: lista os pontos de extremidade disponíveis para o tipo de item, juntamente com detalhes sobre parâmetros, formatos de solicitação e resposta e exemplos.

  • Modelos: define o modelo de dados para o tipo de item, especificando propriedades e tipos.

  • Ações: lista as ações disponíveis para o tipo de item, incluindo detalhes sobre parâmetros, formatos de solicitação e resposta e exemplos.

Use a entrada específica do item para entender os aspectos exclusivos da API relacionada a um tipo de item específico e para obter diretrizes sobre como executar operações relacionadas a esse tipo de item.

Estrutura de página de referência

Cada página de referência tem as seguintes seções:

  • Visão geral – um parágrafo curto na parte superior do artigo que descreve a API.

  • Permissões – uma lista de permissões de usuário necessárias para chamar a API.

  • Escopo necessário – uma lista de permissões (também conhecidas como escopos) que a API requer.

  • Limitações – (opcional) Uma lista de limitações para a API.

  • Interface – Exibe a forma HTTP da API.

  • Parâmetros de URI – uma lista de parâmetros usados para identificar um recurso ou recursos específicos.

  • Corpo da Solicitação – uma lista de propriedades que podem ser passadas para a API.

  • Respostas – uma lista de possíveis respostas da API.

  • Exemplos – uma lista de exemplos que mostram como usar a API.

  • Definições – Parâmetros que definem a estrutura e as propriedades de um objeto que podem ser passados para a API.

A nova estrutura de referência da documentação da API destina-se a fornecer uma maneira clara e consistente de acessar e usar as informações da API. Separando a seção CORE e a entrada específica do item, esperamos facilitar a localização e o uso das informações necessárias para os desenvolvedores se integrarem ao serviço Microsoft Fabric.

Damos as boas-vindas aos seus comentários e sugestões sobre como melhorar a documentação e a API.

Conteúdo relacionado

  • Last updated on