AiImageTaskManager

AI image generation task management and API test automation backend system built with ASP.NET Core Web API.

This project simulates an AI image generation workflow. Users can register, log in, create image generation tasks, track task status, process tasks asynchronously through a background service, store generated image records, and manage API test cases with execution history.

Current version uses a mock PNG output to simulate image generation. Stable Diffusion WebUI / ComfyUI integration is planned as a future enhancement.

Features

JWT Authentication

User registration
User login
JWT token generation
Protected API endpoints
Current user profile endpoint
User-based data isolation

Authentication endpoints:

POST /api/auth/register
POST /api/auth/login
GET  /api/auth/me

After login, protected endpoints require a JWT bearer token:

Authorization: Bearer {token}

Image Task Management

Create image generation tasks
Query all image tasks owned by the current user
Query a single image task owned by the current user
Cancel image tasks
Track task status
User-based task ownership

Task status flow:

Pending → Running → Completed

Supported task statuses:

Pending
Running
Completed
Failed
Cancelled

Background Processing

The project uses ASP.NET Core BackgroundService to simulate asynchronous image generation.

When a task is created, the system stores it as Pending. The background service then picks up pending tasks, changes the status to Running, simulates processing, stores a generated image record, and marks the task as Completed.

Generated Image Storage

After a task is completed, the system stores a generated image file under:

wwwroot/images/generated

The generated image metadata is also stored in the database, including:

Image path
Thumbnail path
File size
Width
Height
Created time

The image can be accessed through a static file URL, for example:

/images/generated/task-11-20260603090034.png

API Test Case Module

The project includes a simple API test automation module.

It supports:

Create API test cases
Query API test cases owned by the current user
Execute HTTP requests
Validate expected HTTP status code
Store test execution results
Query test run history
User-based test case ownership

Docker Compose Support

The project can be run with Docker Compose.

Docker Compose runs the API in a container and stores persistent data in local mounted folders:

docker-data
docker-generated-images

Screenshots

Swagger API Overview

Generated Image Result

After an image task is completed, the system stores a generated image file and returns the generated image path through the API.

Tech Stack

C#
ASP.NET Core Web API
JWT Bearer Authentication
Entity Framework Core
SQLite
BackgroundService
Swagger / OpenAPI
xUnit
WebApplicationFactory
GitHub Actions CI
Docker
Docker Compose
Local file storage

Project Structure

AiImageTaskManager
├── AiImageTaskManager.Api
│   ├── Controllers
│   ├── Services
│   ├── Program.cs
│   └── wwwroot/images/generated
│
├── AiImageTaskManager.Application
│   ├── DTOs
│   └── Interfaces
│
├── AiImageTaskManager.Domain
│   ├── Entities
│   └── Enums
│
├── AiImageTaskManager.Infrastructure
│   ├── BackgroundJobs
│   ├── Data
│   ├── FileStorage
│   └── Services
│
├── AiImageTaskManager.IntegrationTests
│   ├── ApiTestCases
│   ├── Factories
│   ├── Helpers
│   └── ImageTasks
│
├── Dockerfile
├── docker-compose.yml
└── .dockerignore

API Endpoints

Auth

POST   /api/auth/register
POST   /api/auth/login
GET    /api/auth/me

Image Tasks

GET    /api/image-tasks
POST   /api/image-tasks
GET    /api/image-tasks/{id}
POST   /api/image-tasks/{id}/cancel
GET    /api/image-tasks/{id}/images

API Test Cases

GET    /api/test-cases
POST   /api/test-cases
GET    /api/test-cases/{id}
POST   /api/test-cases/{id}/run
GET    /api/test-cases/{id}/runs

Example Requests

Register

POST /api/auth/register

{
  "email": "test@example.com",
  "displayName": "Test User",
  "password": "P@ssw0rd123"
}

Login

POST /api/auth/login

{
  "email": "test@example.com",
  "password": "P@ssw0rd123"
}

Example response:

{
  "userId": 1,
  "email": "test@example.com",
  "displayName": "Test User",
  "token": "eyJhbGciOiJIUzI1NiIs..."
}

Get Current User

GET /api/auth/me
Authorization: Bearer {token}

Example response:

{
  "userId": 1,
  "email": "test@example.com",
  "displayName": "Test User"
}

Create Image Task

POST /api/image-tasks
Authorization: Bearer {token}

{
  "prompt": "a realistic train running on railway tracks",
  "negativePrompt": "blurry, low quality",
  "width": 512,
  "height": 512,
  "steps": 20,
  "cfgScale": 7,
  "seed": 12345
}

Get Generated Images

GET /api/image-tasks/{id}/images
Authorization: Bearer {token}

Example response:

[
  {
    "id": 5,
    "imageGenerationTaskId": 11,
    "imagePath": "/images/generated/task-11-20260603090034.png",
    "thumbnailPath": "/images/generated/task-11-20260603090034.png",
    "fileSize": 68,
    "width": 512,
    "height": 512,
    "createdAt": "2026-06-03T09:00:34.3800029"
  }
]

Create API Test Case

POST /api/test-cases
Authorization: Bearer {token}

{
  "name": "Login endpoint should return 200",
  "method": "POST",
  "url": "https://localhost:7074/api/auth/login",
  "headersJson": null,
  "bodyJson": "{\"email\":\"test@example.com\",\"password\":\"P@ssw0rd123\"}",
  "expectedStatusCode": 200
}

HTTP Test File

JWT-protected endpoints can be tested using the included .http file.

Recommended local base URL:

@baseUrl = https://localhost:7074

Recommended Docker base URL:

@dockerBaseUrl = http://localhost:8080

Example:

@baseUrl = https://localhost:7074
@token = PASTE_JWT_TOKEN_HERE

### Get current user
GET {{baseUrl}}/api/auth/me
Authorization: Bearer {{token}}

### Get image tasks
GET {{baseUrl}}/api/image-tasks
Authorization: Bearer {{token}}

Docker example:

@dockerBaseUrl = http://localhost:8080
@dockerToken = PASTE_DOCKER_JWT_TOKEN_HERE

### Docker current user
GET {{dockerBaseUrl}}/api/auth/me
Authorization: Bearer {{dockerToken}}

Note: Swagger UI may not consistently attach the Authorization header in the current .NET 10 / Swashbuckle setup. The .http file is recommended for testing JWT-protected endpoints.

Integration Tests

This project uses xUnit and WebApplicationFactory for integration testing.

The test environment uses InMemoryDatabase to avoid affecting the local SQLite development database. Integration tests also register a test user and attach a JWT token to test protected endpoints.

Current integration tests cover:

User authentication setup for tests
Create image task
Get image task list
Get image task by ID
Get non-existing image task
Create API test case
Get API test case list
Get API test case by ID
Get non-existing API test case

Run tests:

dotnet test

CI/CD

This project uses GitHub Actions for continuous integration.

The workflow runs automatically on every push or pull request to main and executes:

dotnet restore
dotnet build
dotnet test

Getting Started

Prerequisites

.NET 10 SDK
Git
Visual Studio 2026 or later
EF Core CLI tools
Docker Desktop

1. Clone the repository

git clone https://github.com/t0037798/AiImageTaskManager.git
cd AiImageTaskManager

2. Restore packages

dotnet restore AiImageTaskManager.slnx

3. Apply database migration

dotnet ef database update --project AiImageTaskManager.Infrastructure --startup-project AiImageTaskManager.Api

4. Run the API locally

dotnet run --project AiImageTaskManager.Api

After the API starts, open Swagger:

https://localhost:7074/swagger

Run with Docker Compose

The API can also be started with Docker Compose.

docker compose up --build

After the container starts, open Swagger:

http://localhost:8080/swagger

Docker Compose uses mounted folders to persist SQLite data and generated images:

docker-data
docker-generated-images

To stop the container:

docker compose down

To remove local Docker data:

rm -rf docker-data docker-generated-images

On Windows PowerShell:

Remove-Item -Recurse -Force .\docker-data
Remove-Item -Recurse -Force .\docker-generated-images

Key Highlights

Layered architecture separating API, Application, Domain, and Infrastructure
JWT-based authentication and user-based data isolation
EF Core migration-based database management
BackgroundService-based asynchronous task processing
Generated image metadata and local static file storage
API test case management and execution history
xUnit integration tests with isolated test database
GitHub Actions CI for automated build and test
Docker Compose support for containerized execution

Current Limitations

Image generation currently uses a mock PNG file instead of a real AI generation model.
Stable Diffusion WebUI / ComfyUI integration is not implemented yet.
Swagger UI authorization may not consistently attach the Authorization header in the current .NET 10 / Swashbuckle setup.
API test cases currently validate HTTP status code only.
Frontend dashboard is not implemented yet.

Future Work

Integrate Stable Diffusion WebUI API or ComfyUI API
Add frontend dashboard
Support response body validation for API test cases
Support multi-step API test workflows
Replace SQLite with PostgreSQL or SQL Server
Add refresh token support
Add role-based authorization

Name		Name	Last commit message	Last commit date
Latest commit History 11 Commits
.github/workflows		.github/workflows
AiImageTaskManager.Api		AiImageTaskManager.Api
AiImageTaskManager.Application		AiImageTaskManager.Application
AiImageTaskManager.Domain		AiImageTaskManager.Domain
AiImageTaskManager.Infrastructure		AiImageTaskManager.Infrastructure
AiImageTaskManager.IntegrationTests		AiImageTaskManager.IntegrationTests
docs/images		docs/images
.dockerignore		.dockerignore
.gitignore		.gitignore
AiImageTaskManager.slnx		AiImageTaskManager.slnx
Dockerfile		Dockerfile
README.md		README.md
docker-compose.yml		docker-compose.yml

Folders and files

Latest commit

History

Repository files navigation

AiImageTaskManager

Features

JWT Authentication

Image Task Management

Background Processing

Generated Image Storage

API Test Case Module

Docker Compose Support

Screenshots

Swagger API Overview

Generated Image Result

Tech Stack

Project Structure

API Endpoints

Auth

Image Tasks

API Test Cases

Example Requests

Register

Login

Get Current User

Create Image Task

Get Generated Images

Create API Test Case

HTTP Test File

Integration Tests

CI/CD

Getting Started

Prerequisites

1. Clone the repository

2. Restore packages

3. Apply database migration

4. Run the API locally

Run with Docker Compose

Key Highlights

Current Limitations

Future Work

About

Topics

Resources

Uh oh!

Stars

Watchers

Forks

Releases 1

Packages 0

Uh oh!

Contributors

Uh oh!

Languages

Packages