inicialización del flujo de trabajo de la API de UIP

Sintaxis y opciones para `uip api-workflow init`, que andamia un nuevo proyecto de flujo de trabajo de API con archivos modelo.

uip api-workflow init andamia un nuevo proyecto de flujo de trabajoproject.uiproj entry-points.jsondebindings_v2.json API:,, y un mínimo Workflow.json con un solo paso de transferencia que asigna los valores predeterminados de entrada declarados y luego la entrada real de la persona que llama,$input en. Cuando se ejecuta dentro de un directorio de soluciones, el nuevo proyecto se registra automáticamente en el archivo .uipx de la solución circundante.

Sinopsis

uip api-workflow init <name> [options]

• <name> — Nombre del proyecto de flujo de trabajo de API. Solo letras, números, espacios, guiones bajos (_) y guiones (-); también se utiliza como nombre del directorio de destino.

Opciones

Marca	Descripción
--force	Inicializar incluso si el directorio de destino no está vacío. Escribe archivos sin borrar los contenidos existentes: no elimina nada que ya esté allí.
--skip-solution-registration	No registre automáticamente este proyecto en la solución circundante.

Ejemplos

# 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

Forma de datos (--json de salida)

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

SolutionRegistration refleja si el proyecto se vinculó a .uipx de una solución principal. Cuando el flujo de registro necesita que el usuario realice un paso manual (por ejemplo, no se encontró ninguna solución principal), la respuesta añade un campo NextSteps con instrucciones.

Relacionado

• uip api-workflow build : compila el proyecto que este comando aplica.
• uip api-workflow validate : valida el flujo de trabajo JSON antes de empaquetar.

Ver también

• Descripción general de la herramienta de flujo de trabajo de API
• Opciones globales
• Códigos de salida