Tisa.BpmApp 2026.1.9.705

Tisa.BpmApp

Базовые классы и компоненты приложений ТИСА для работы с использованием .NET Core на платформе BPMSoft.

Описание

Tisa.BpmApp — NuGet-библиотека, предоставляющая набор Service Installers для быстрой настройки ASP.NET Core приложения на платформе BPMSoft: аутентификация (JWT + API-key), авторизация, логирование (Serilog), Mediator-пайплайн, OpenAPI-заголовки.

Основные возможности

• Поддержка .NET 8.0, .NET 9.0 и .NET 10.0
• Интеграция с платформой BPMSoft
• Аутентификация по JWT и API-ключу
• Авторизация с поддержкой расширенных политик
• Валидация данных с использованием FluentValidation
• Mediator-пайплайн (LoggingBehavior, ValidationBehavior)
• Генерация OpenAPI-документации (NSwag)
• Документация API: Swagger UI (/swagger) и Scalar (/scalar) — через пакет Tisa.BpmApp.Hosting
• Логирование через Serilog с маршрутизацией по токену

Требования

• .NET 8.0 или выше
• BPMSoft платформа

Установка

dotnet add package Tisa.BpmApp

Актуальный номер версии пакета смотрите на nuget.org/packages/Tisa.BpmApp.

В пакете в папке Docs/ поставляются App.config (полная конфигурация BPMSoft) и BPMSoft.WebHost.dll.config (минимально настроенная рабочая версия). Копирование BPMSoft.WebHost.dll.config в выходной каталог приложения (bin/...) обеспечивает транзитивная зависимость Tisa.BpmCore — подробнее см. документацию Tisa.BpmCore.

Требования для проектов, использующих пакет и для прямого создания UserConnection

В проектах, использующих пакет Tisa.BpmApp, и при необходимости прямого создания объекта UserConnection внутри приложения дополнительно необходимы:

Целевая платформа: при использовании класса UserConnection в проекте с данным пакетом указывайте целевую платформу .NET 8.0 — BPMSoft в настоящее время поддерживает только её.

1. Файл конфигурации ядра BPMSoft

Используйте файл Tisa.BpmApp/Docs/App.config: в нём приведена полная конфигурация (все типовые секции и настройки) — удобно как справочник и для переноса фрагментов в свой проект. Файл входит в пакет Tisa.BpmApp и должен быть подключён к проекту (например, как контент или копия в выходную директорию).

Для запуска приложения обычно используют BPMSoft.WebHost.dll.config — минимально настроенная рабочая версия (см. раздел «Конфигурационные файлы в Docs» ниже); App.config не заменяет её автоматически, а дополняет документацией по полному составу настроек.

2. Ссылки на сборки платформы BPMSoft

Содержимое файла Tisa.BpmApp/Docs/BpmSoft.xml должно быть скопировано в проект (например, в .csproj в виде блока <ItemGroup> с <Reference>). Эти сборки не входят в NuGet-пакет вследствие лицензионных ограничений; пути HintPath нужно задать в соответствии с вашей установкой BPMSoft.

Список сборок BPMSoft для ссылок в проекте

• Autofac
• Autofac.Extensions.DependencyInjection
• BPMSoft.Authentication
• BPMSoft.Core.DI
• BPMSoft.Core.DI.Bindings
• BPMSoft.DB.PostgreSql
• BPMSoft.Licensing.Application
• BPMSoft.Licensing.Abstractions
• BPMSoft.Licensing.Domain
• BPMSoft.Messaging.Common
• BPMSoft.Monitoring
• BPMSoft.Redis
• BPMSoft.Redis.Abstractions
• BPMSoft.Redis.StackExchangeAdapters
• BPMSoft.Security
• BPMSoft.Store.WebAdapters
• BPMSoft.Web.Http.Abstractions
• BPMSoft.Web.Http.AspNetCore
• BPMSoft.Webhooks
• Ninject
• Ninject.Extensions.Factory
• StackExchange.Redis

Скопируйте блок <ItemGroup> с <Reference> из файла BpmSoft.xml в папке Docs пакета и при необходимости скорректируйте HintPath под вашу установку BPMSoft.

Конфигурационные файлы в Docs/

Транзитивный пакет Tisa.BpmCore дополнительно доставляет BPMSoft.WebHost.dll.config в выходной каталог потребителя — см. Readme Tisa.BpmCore.

Использование

Регистрация сервисов

public void ConfigureServices(IServiceCollection services, IConfiguration configuration)
{
    services.AddBpmApplication(configuration);
}

Метод AddBpmApplication автоматически регистрирует все Service Installers из сборки: API, аутентификацию, авторизацию, логирование, Mediator-пайплайн и middleware.

Документация API (Swagger UI и Scalar)

Для host-приложений используйте пакет Tisa.BpmApp.Hosting:

builder.Services.AddBpmAppHosting(builder.Configuration, options =>
{
    options.DocumentName = "My Integration 1.0";
    options.Title = "My Integration API";
    options.ApiKeyHeaderName = "tisa-api-key";
});

var app = builder.Build();
app.UseBpmAppHosting();

После запуска:

Пример: проект App/ в репозитории пакета Tisa.BpmApp.

Зависимости

• FluentValidation (>= 12.1.1)
• Mediator.Abstractions (>= 3.0.1)
• NSwag.Generation (>= 14.6.3)
• Tisa.Authorization
• Tisa.BpmCore

Структура проекта

• Authentication/ — Аутентификация по API-ключу (ApikeyAuth)
• Headers/ — OpenAPI-процессоры для кастомных заголовков
• ServiceInstallers/ — Модульные инсталляторы сервисов:
  • Api/ — Настройка API и ApiBehaviorOptions
  • Authentication/ — JWT и API-key аутентификация, валидация токенов
  • Authorization/ — Авторизация и политики доступа
  • Common/ — Регистрация IBpmCoreService, настройка Email и Telegram
  • Logging/ — Конфигурация Serilog
  • Messaging/ — Mediator-пайплайн (LoggingBehavior, ValidationBehavior)
  • Middleware/ — Автосканирование и регистрация middleware

Условная компиляция

Символ AuthorizationExtended активирует расширенную авторизацию: политику AdminOnly, Scrutor-сканирование IAuthorizationPolicyProvider и IAuthorizationHandler из Tisa.Authorization. Для включения добавьте в csproj:

<DefineConstants>AuthorizationExtended</DefineConstants>

Лицензия

MIT License

Поддержка

По вопросам поддержки и сообщений об ошибках: support@tisn.ru