Compartilhar via


Compilar e executar o construtor de API de Dados no código-fonte

O DAB (Construtor de API de Dados) é um projeto de software livre hospedado no GitHub. A qualquer momento, você pode baixar o código-fonte, modificar o código e executar o projeto diretamente da origem. Este guia inclui todas as etapas necessárias para criar o projeto diretamente de seu código-fonte.

Pré-requisitos

Forkar e clonar o repositório

Comece criando sua própria bifurcação do azure/data-api-builder repositório GitHub. Este fork permite que você mantenha suas próprias alterações. Se você escolher, sempre poderá abrir uma solicitação de pull e sugerir as alterações no repositório upstream.

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

  2. Crie uma bifurcação do repositório em sua própria conta ou organização. Aguarde a conclusão da operação de bifurcação antes de continuar.

  3. Abrir um novo Terminal.

  4. Clone a bifurcação.

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

    Dica

    Como alternativa, você pode abrir a bifurcação 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
    

Acionar o motor

A Azure.DataApiBuilder solução inclui vários projetos. Para executar a ferramenta a partir do código-fonte, execute o Azure.DataApiBuilder.Service projeto passando por um arquivo de configuração.

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

    Dica

    O arquivo .gitignore ignora automaticamente todos os arquivos de configuração do DAB.

  2. Adicione o seguinte conteúdo ao arquivo 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

    Essa é uma configuração de exemplo que pressupõe que você tenha um SQL Server disponível em seu computador local. Se você não fizer isso, pode executar um contêiner do Docker para SQL Server com seus dados de exemplo. Para obter mais informações, consulte a criação de dados de exemplo.

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

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

    Dica

    O mecanismo do Data API builder tentará carregar a configuração a partir do arquivo dab-config.json na mesma pasta, se presente. Se não houver nenhum dab-config.json arquivo, o mecanismo será iniciado de qualquer maneira, mas ele não será capaz de servir nada.