Partilhar via

Construir e executar o Data API Builder a partir do código-fonte

Data API Builder (DAB) é um projeto open-source alojado no GitHub. A qualquer momento, pode descarregar o código-fonte, modificar o código e executar o projeto diretamente a partir da fonte. Este guia inclui todos os passos necessários para construir o projeto diretamente a partir do seu código-fonte.

Pré-requisitos

Fazer um fork e clonar o repositório

Comece por criar o seu próprio fork do azure/data-api-builder repositório do GitHub. Este fork permite-lhe guardar as suas próprias alterações. Se assim o desejar, pode sempre abrir um pull request e sugerir as alterações ao repositório upstream.

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

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

  3. Abra um novo terminal.

  4. Clona o garfo.

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

    Sugestão

    Em alternativa, podes abrir o fork ou o repositório original como um Codespace do GitHub.

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

    dotnet build src/Azure.DataApiBuilder.sln

Liga o motor

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

  1. No diretório raiz, crie um novo ficheiro chamado dab-config.json.

    Sugestão

    O ficheiro .gitignore ignora automaticamente quaisquer ficheiros de configuração 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 assume que tem um SQL Server disponível na sua máquina local. Se não o fizeres, podes correr um contentor Docker para SQL Server com os teus dados de exemplo. Para mais informações, consulte criação de dados de exemplo.

  3. Execute o projeto src/Service/Azure.DataApiBuilder.Service.csproj. Use o --ConfigFileName argumento para especificar o ficheiro de configuração criado na etapa anterior.

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

    Sugestão

    O motor construtor de APIs de dados tenta carregar a configuração a partir do dab-config.json ficheiro na mesma pasta, caso exista. Se não houver ficheiro dab-config.json, o motor ainda assim arranca, mas não consegue servir nada.

Conteúdo relacionado

  • Last updated on