Msm.Workflow.Lib.Api.Controllers 1.2.0

Msm.Workflow.Lib.Api.Controllers

Pre-built REST API controllers cho MSM Workflow Engine - cung cấp CRUD endpoints sẵn có.

📦 Installation

<PackageReference Include="Msm.Workflow.Lib.Api.Controllers" Version="1.0.0" />

dotnet add package Msm.Workflow.Lib.Api.Controllers

📋 Overview

Package này cung cấp pre-built API controllers để tích hợp nhanh workflow engine vào ASP.NET Core application. Có thể sử dụng trực tiếp hoặc inherit để customize.

Contents

• WorkflowProcessesController: CRUD operations cho workflow processes
• WorkflowInstancesController: CRUD operations và workflow execution
• WorkflowTriggerController: Trigger workflow instances
• TenantsController: Multi-tenancy management

🎯 Usage

Register Controllers

using Msm.Workflow.Lib.Api.Controllers;

// In Program.cs or Startup.cs
services.AddWorkflowApiControllers();

Use Controllers Directly

Controllers sẽ tự động được map với routes:

• GET /api/WorkflowProcesses - List all processes
• POST /api/WorkflowProcesses - Create new process
• GET /api/WorkflowInstances/{id} - Get instance details
• POST /api/WorkflowInstances/{id}/approve - Approve workflow item
• POST /api/WorkflowTrigger - Trigger new workflow instance

Inherit and Customize

[ApiController]
[Route("api/[controller]")]
public class MyWorkflowController : BaseWorkflowController
{
    public MyWorkflowController(
        IWorkflowProcessService processService,
        IWorkflowInstanceService instanceService)
        : base(processService, instanceService)
    {
    }

    // Add custom endpoints
    [HttpPost("custom-action")]
    public async Task<IActionResult> CustomAction()
    {
        // Your custom logic
    }
}

Example API Calls

# Create workflow process
POST /api/WorkflowProcesses
{
  "name": "Purchase Order Approval",
  "code": "PO_APPROVAL",
  "objectType": "PURCHASE_ORDER"
}

# Trigger workflow instance
POST /api/WorkflowTrigger
{
  "processCode": "PO_APPROVAL",
  "objectId": "po-123",
  "objectType": "PURCHASE_ORDER",
  "submitterId": "user123"
}

# Approve workflow item
POST /api/WorkflowInstances/{instanceId}/approve
{
  "itemId": "item-123",
  "approverId": "user456",
  "comment": "Approved"
}

🔗 Dependencies

• Msm.Workflow.Lib.Application (required)
• Microsoft.AspNetCore.App (framework reference)

📚 Related Packages

• Msm.Workflow.Lib.Application - Required dependency
• Msm.Workflow.Lib.Infrastructure - Required for data access
• Msm.Workflow.Lib.Domain - Required for domain entities

🔒 Multi-Tenancy

Controllers hỗ trợ multi-tenancy qua x-tenant header:

# Request với tenant header
curl -H "x-tenant: tenant1" \
     -H "Content-Type: application/json" \
     http://localhost:5000/api/WorkflowProcesses

📖 Documentation

For more information, see the main README.md and GETTING_STARTED.md.