quickapi-schema.json

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "BiwenQuickApi": {
      "type": "object",
      "description": "BiwenQuickApi",
      "properties": {
        "QuickApi": {
          "type": "object",
          "description": "QuickApi",
          "properties": {
            "RoutePrefix": {
              "type": "string",
              "default": "api",
              "description": "QuickApi前缀,默认:api"
            },
            "EnableAntiForgeryTokens": {
              "type": "boolean",
              "default": true,
              "description": "默认:true"
            },
            "EnablePubSub": {
              "type": "boolean",
              "default": true,
              "description": "是否启用内置发布订阅,默认:true"
            },
            "EnableScheduling": {
              "type": "boolean",
              "default": true,
              "description": "是否启用内置Schedule,默认:true"
            },
            "UseQuickApiExceptionResultBuilder": {
              "type": "boolean",
              "default": false,
              "description": "是否500返回详细信息,默认:false"
            }
          }
        },

        "MiniProfiler": {
          "type": "object",
          "description": "MiniProfiler配置项",
          "properties": {
            "Enabled": {
              "type": "boolean",
              "default": false,
              "description": "是否启用MiniProfiler,默认:false"
            },
            "PopupShowTrivial": {
              "type": "boolean",
              "default": false,
              "description": "是否显示Trivial,默认:false"
            },
            "PopupRenderPosition": {
              "type": "string",
              "default": "TopLeft",
              "enum": [ "TopLeft", "BottomLeft", "TopRigth", "BottomRight" ],
              "description": "弹出位置,默认:TopLeft"
            }
          }
        },

        "Schedules": {
          "type": "array",
          "description": "定时任务集合",
          "items": {
            "type": "object",
            "properties": {
              "ScheduleTaskType": {
                "type": "string",
                "description": "定时任务类型"
              },
              "Cron": {
                "type": "string",
                "description": "Cron表达式"
              },
              "Description": {
                "type": "string",
                "description": "描述信息"
              },
              "IsAsync": {
                "type": "boolean",
                "default": false,
                "description": "是否异步,默认:false,表示同步阻塞执行"
              },
              "IsStartOnInit": {
                "type": "boolean",
                "default": false,
                "description": "是否初始化就启动,默认:false"
              }
            }
          },
          "required": [ "Cron", "ScheduleTaskType" ]
        },

        "Telemetry": {
          "type": "object",
          "properties": {
            "Enable": {
              "type": "boolean",
              "default": false,
              "description": "是否启用Telemetry,默认:false"
            },
            "SamplingInterval": {
              "type": "integer",
              "default": 15,
              "description": "采样间隔,单位秒,默认:15秒,介于5~900之间",
              "minimum": 5,
              "maximum": 900
            }
          }
        },

        "MultiTenants": {

          "type": "array",
          "description": "多租户配置",
          "items": {

            "type": "object",
            "properties": {
              "Id": {
                "type": "string",
                "description": "租户Id"
              },
              "Name": {
                "type": "string",
                "description": "租户名称"
              },
              "Identifier": {
                "type": "string",
                "description": "Identifier,针对不同的Finder可能是正则表达式等,默认忽略大小写!"
              },
              "ConnectionString": {
                "type": "string",
                "description": "数据库连接字符串,该项针对自定义TInfo不是必须项!"
              }
            },
            "required": [ "Id", "Name", "Identifier" ]
          }
        }
      }

    }
  }
}