init do fluxo de trabalho da API do uip

Sintaxe e opções para "uip api-workflow init", que estrutura um novo projeto de fluxo de trabalho de API com arquivos boilerplate.

uip api-workflow init estrutura um novo projeto de fluxo de trabalho de API: project.uiproj, entry-points.json, bindings_v2.json e um mínimo Workflow.json com uma única etapa de passagem que mapeia os padrões de entrada declarados e, em seguida, a entrada real do chamador, em $input. Quando executado dentro de um diretório de soluções, o novo projeto é registrado automaticamente no arquivo .uipx da solução adjacente.

Resumo

uip api-workflow init <name> [options]

• <name> — Nome do projeto do fluxo de trabalho da API. Somente letras, números, espaços, sublinhados (_) e hifens (-); também usado como o nome do diretório de destino.

Opções

Bandeira	Description
--force	Inicialize mesmo que o diretório de destino não esteja vazio. Grava arquivos sem limpar o conteúdo existente — não exclui nada que já esteja lá.
--skip-solution-registration	Não registre automaticamente este projeto na solução ao redor.

Exemplos

# Create a new API Workflow project
uip api-workflow init my-api-workflow

# Initialize into a non-empty directory
uip api-workflow init my-api-workflow --force

Formato dos dados (--output json)

{
  "Code": "ApiWorkflowInit",
  "Data": {
    "Status": "Created successfully",
    "Path": "/workspace/my-api-workflow",
    "SolutionRegistration": {
      "Registered": true
    }
  }
}

SolutionRegistration reflete se o projeto foi vinculado ao .uipx de uma solução pai. Quando o fluxo de registro precisa que o usuário realize uma etapa manual (por exemplo, nenhuma solução pai foi encontrada), a resposta adiciona um campo NextSteps com instruções.

Relacionado

• compilação do uip api-workflow — compile o projeto que este comando suporta.
• uip api-workflow validate — validar o fluxo de trabalho JSON antes do empacotamento.

Veja também

• Visão geral da ferramenta Fluxo de trabalho da API
• Opções globais
• Códigos de saída