Partilhar via

Criar e executar o Construtor de API de Dados a partir do código fonte

  • Artigo

O Construtor de API de Dados (DAB) é um projeto open source alojado no GitHub. Em qualquer altura, pode transferir o código fonte, modificar o código e executar o projeto diretamente a partir da origem. Este guia inclui todos os passos necessários para criar o projeto diretamente a partir do respetivo código fonte.

Pré-requisitos

Fork e clonar o repositório

Comece por criar o seu próprio fork do repositório do azure/data-api-builder GitHub. Este fork permite-lhe manter as suas próprias alterações. Se assim o preferir, pode sempre abrir um pedido Pull e sugerir as alterações ao repositório a montante.

  1. Navegue para https://github.com/azure/data-api-builder/fork.

  2. Create um fork do repositório na sua própria conta ou organização. Aguarde até que a operação de forking seja concluída antes de continuar.

  3. Abra um novo terminal.

  4. Clone o fork.

    git clone https://github.com/<your-username>/data-api-builder.git

    Dica

    Em alternativa, pode abrir o fork ou o repositório original como um Espaço de Código do GitHub.

  5. Crie a src/Azure.DataApiBuilder.sln solução.

    dotnet build src/Azure.DataApiBuilder.sln

Executar o motor

A Azure.DataApiBuilder solução inclui vários projetos. Para executar a ferramenta a partir da origem, execute o Azure.DataApiBuilder.Service projeto que transmite um ficheiro de configuração.

  1. No diretório de raiz, crie um novo ficheiro com o nome dab-config.json.

    Dica

    O ficheiro .gitignore ignora automaticamente quaisquer ficheiros de configuração da DAB.

  2. Adicione o seguinte conteúdo ao ficheiro de configuração.

    {
  "$schema": "https://github.com/Azure/data-api-builder/releases/latest/download/dab.draft.schema.json",
  "data-source": {
    "database-type": "mssql",
    "connection-string": "Server=localhost,1433;Initial Catalog=Library;User Id=sa;Password=<your-password>;TrustServerCertificate=true;"
  },
  "entities": {
    "book": {
      "source": "dbo.Books",
      "permissions": [
        {
          "actions": [
            "read"
          ],
          "role": "anonymous"
        }
      ]
    }
  }
}

    Importante

    Esta é uma configuração de exemplo que pressupõe que tem um SQL Server disponível no seu computador local. Se não o fizer, pode executar um contentor do Docker para SQL Server com os seus dados de exemplo. Para obter mais informações, veja Criar dados de exemplo.

  3. Execute o src/Service/Azure.DataApiBuilder.Service.csproj projeto. Utilize o --ConfigFileName argumento para especificar o ficheiro de configuração criado no passo anterior.

    dotnet run --project src/Service/Azure.DataApiBuilder.Service.csproj --ConfigFileName ../../dab-config.json

    Dica

    O motor do construtor de API de Dados tentará carregar a configuração do dab-config.json ficheiro na mesma pasta, se estiver presente. Se não existir nenhum dab-config.json ficheiro, o motor será iniciado de qualquer forma, mas não poderá servir nada.

Conteúdo relacionado