EaCloud.Swagger 7.0.2.2

EaCloud Swagger API 文档生成组件

说明

集成 Swagger API 文档生成组件，方便前后端分离的开发模式中前后端开发人员的数据接口对接工作。基于Swagger的工作原理，API的输入输出都需使用强类型的数据类型，Swagger才能发挥更好的作用，而EaCloud框架通过AutoMapper的ProjectTo对业务实体到输出DTOIOutputDto提供了自动映射功能，能有效减轻后端开发中数据对象属性映射的工作量。

用法

可按照如下配置方式使用：

1. 通过nuget引用 EaCloud.Swagger 程序集

Install-Package EaCloud.Swagger

2. 在 appsettings.json 中 的 EaCloud 节点下添加如下配置节点

{
   //Swagger选项
    "Swagger": {
      "UI": "swagger", //界面样式：knife4j、swagger(默认)。
      "DocumentTitle": "接口文档", //界面标题
      "HeadContent": "", //标头内容
      "RoutePrefix": "swagger", //路由前缀
      "IsHideSchemas": false, //隐藏架构
      "MiniProfiler": true, //启用轻量级工具分析
      // 注释文档
      "CommentDoc": {
        "SearchPattern": "eacloud*.xml", //与要搜索的文件名匹配的搜索字符串。此参数可以包含有效文本路径和通配符（*和？）的组合字符，但它不支持正则表达式。默认"eacloud*.xml"。
        "FilterExpression": "" //过滤文档文件的正则表达式，用于筛选后的特殊过滤。
      },
      //分组集合
      "Groups": [
        {
          "Name": "api", //名称
          "Title": "框架API", //标题
          "Description": "框架API", //描述
          "Url": "", //Url
          // 联系人
          "Contact": {
            "Name": "EaCloud", //联系人名称
            "Url": "https://toscode.gitee.com/eacloud", //联系人链接
            "Email": "union@sanqing.tech" //联系人邮箱
          },
          // 许可
          "License": {
            "Name": "Apache", //许可名称
            "Url": "https://www.apache.org/licenses/LICENSE-2.0" //许可链接
          },
          "Visible": true //是否可见
        },
        {
          "Name": "buss", //名称
          "Title": "业务API", //标题
          "Description": "业务API", //描述
          "Url": "/swagger/buss/swagger.json", //Url
          // 联系人
          "Contact": {
            "Name": "EaCloud", //联系人名称
            "Url": "https://toscode.gitee.com/eacloud", //联系人链接
            "Email": "union@sanqing.tech" //联系人邮箱
          },
          // 许可
          "License": {
            "Name": "MIT", //许可名称
            "Url": "https://opensource.org/licenses/MIT" //许可链接
          },
          "Visible": false //是否可见
        }
      ],
      "Enabled": true //是否启用
    },
}

3. 要禁用Swagger，可以设置Enabled: false

交流

| |  | | :-: | :-: | | QQ群号：863605868 | 微信号：SeonHu |