Yyt.Abp.Swagger 1.0.2

Yyt.Abp.Swagger

English Version

Overview

Yyt.Abp.Swagger is a library that simplifies Swagger configuration for .NET applications,Version 1.0.2 added support for net8. Built with a modular architecture, it can be seamlessly integrated into your existing projects. Supported by Patrick.Z, this library streamlines repetitive daily development configurations and takes the heavy lifting off your shoulders.

Why Choose Yyt.Abp.Swagger?

• Minimal Dependencies: Lightweight design with minimal external dependencies, keeps your project lean and efficient.
• Secure by Design: Security is prioritized from the design phase to reduce potential vulnerabilities.
• Highly Extensible: Easy to extend and customize to meet your specific project requirements.
• Battle-Tested: Proven stable and reliable through validation in multiple production projects.

Core Features

• Custom configuration for Swagger UI page title: Configure the browser title for Swagger UI.
• Support for grouping API endpoints with custom display names: Organize API endpoints into groups with custom names.
• Allows hierarchical configuration of primary/secondary route directories: Configure hierarchical route structures.
• Supports dynamic enable/disable of the Swagger documentation endpoint: Toggle Swagger endpoint availability dynamically.

Code Integration Example

namespace Demo.HttpApi.Host
{
    [DependsOn(
      typeof(VoloSwaggerModule)
    )]
    public class DemoHttpApiHostModule : AbpModule
    {
        // config service & other
    }
}

Configuration Example

appsettings.json:

{
  "SwaggerConfig": {
    "BrowserTitle": "applicationmanager",
    "GroupName": "applicationmanager api",
    "Title": "applicationmanager service",
    "Description": "applicationmanager desc",
    "ProjectRoot": "Yyt.App",
    "UrlFirstPrefix": "yyt",
    "UrlSecondPrefix": "",
    "IsEnble": true
  }
}

Chinese Version

概述

Yyt.Abp.Swagger 简化了对 Swagger 的配置,Version 1.0.2 增加了对net8的支持。代码采用了 Module 模块化设计，能无缝集成到项目中。该库由 Patrick.Z 提供支持，简化了 .Net 应用程序中的日常开发配置工作，为您分担繁重的工作。

为什么选择 Yyt.Abp.Swagger？

• 极少依赖：轻量级设计，外部依赖少，保持项目精简高效
• 设计安全：从设计阶段就优先考虑安全性，减少潜在漏洞
• 可扩展定制：易于扩展和定制，满足特定项目需求
• 久经沙场：经过多个生产项目验证，稳定可靠

核心功能

• 配置 Swagger 网页标题：自定义 Swagger UI 的浏览器标题
• 分组名称配置：支持使用自定义显示名称对 API 端点进行分组
• 一级二级目录配置：支持层级化的路由目录配置
• 动态启用/禁用：支持动态启用或禁用 Swagger 文档端点

代码模块集成示例

namespace Demo.HttpApi.Host
{
    [DependsOn(
      typeof(VoloSwaggerModule)
    )]
    public class DemoHttpApiHostModule : AbpModule
    {
        // config service & other
    }
}

配置示例

appsettings.json：

{
  "SwaggerConfig": {
    "BrowserTitle": "applicationmanager",
    "GroupName": "applicationmanager api",
    "Title": "applicationmanager service",
    "Description": "applicationmanager desc",
    "ProjectRoot": "Yyt.App",
    "UrlFirstPrefix": "yyt",
    "UrlSecondPrefix": "",
    "IsEnble": true
  }
}

Document Version: v1.0
Created Date: June 2026
Author: Patrick.Z