hope-common.swagger.0.5.2-RELEASE.json Maven / Gradle / Ivy
{
"openapi" : "3.0.1",
"paths" : { },
"components" : {
"schemas" : {
"Error" : {
"type" : "object",
"description" : "错误对象",
"properties" : {
"code" : {
"type" : "integer",
"format" : "int32",
"description" : "错误码",
"example" : 1000001001
},
"title" : {
"type" : "string",
"description" : "错误标题",
"example" : "USER_NAME_EMPTY"
},
"description" : {
"type" : "string",
"description" : "错误描述",
"example" : "user name should not be empty"
},
"descriptionZhCN" : {
"type" : "string",
"description" : "错误描述(中)",
"example" : "用户名不可以为空"
},
"field" : {
"type" : "string",
"description" : "字段",
"example" : "name"
},
"path" : {
"type" : "string",
"description" : "字段路径",
"example" : "user.name"
},
"rejectedValue" : {
"type" : "string",
"description" : "输入值",
"example" : "Jake.Bush"
},
"tips" : {
"type" : "string",
"description" : "使用提示",
"example" : "价格必须是正数:1000.12"
},
"constraint" : {
"type" : "string",
"description" : "校验规则",
"example" : "POSITIVE|NOT_EMPTY|REG_EXP"
},
"phase" : {
"$ref" : "#/components/schemas/ProblemPhase",
"description" : "错误阶段",
"example" : "DOMAIN:表示在领域层"
},
"severity" : {
"$ref" : "#/components/schemas/ProblemSeverity",
"description" : "错误程度",
"example" : "ERROR: 表示业务中断"
},
"domain" : {
"type" : "string",
"description" : "领域",
"example" : "order"
},
"properties" : {
"type" : "object",
"description" : "其他属性(KV), flat to normal fields refer to the problem details of hope/spring",
"example" : "扩展属性, Key-Value 对"
}
},
"title" : "Error"
},
"ProblemSeverity" : {
"default" : "LOW",
"description" : "错误严重程度",
"oneOf" : [ {
"const" : "LOW",
"description" : "Low",
"example" : "LOW",
"title" : "LOW",
"x-hope-enum-item-code" : 1,
"x-hope-enum-item-des-cn" : "低,无影响"
}, {
"const" : "WARN",
"description" : "Warn",
"example" : "WARN",
"title" : "WARN",
"x-hope-enum-item-code" : 2,
"x-hope-enum-item-des-cn" : "警告,业务错误可重试"
}, {
"const" : "ERROR",
"description" : "Error",
"example" : "ERROR",
"title" : "ERROR",
"x-hope-enum-item-code" : 4,
"x-hope-enum-item-des-cn" : "错误,业务无法进行"
}, {
"const" : "FATAL",
"description" : "Fatal",
"example" : "FATAL",
"title" : "FATAL",
"x-hope-enum-item-code" : 8,
"x-hope-enum-item-des-cn" : "灾难,数据破坏"
} ],
"title" : "ProblemSeverity",
"x-hope-rt-meta" : {
"clz" : "hope.common.wire.constant.ProblemSeverity",
"protoFrom" : "hope/common/proto/constant/common.proto"
},
"x-hope-enum-type" : "true"
},
"ProblemPhase" : {
"default" : "CONTROLLER",
"description" : "错误层次",
"oneOf" : [ {
"const" : "CONTROLLER",
"description" : "Controller",
"example" : "CONTROLLER",
"title" : "CONTROLLER",
"x-hope-enum-item-code" : 1,
"x-hope-enum-item-des-cn" : "表单层"
}, {
"const" : "SERVICE",
"description" : "Service",
"example" : "SERVICE",
"title" : "SERVICE",
"x-hope-enum-item-code" : 2,
"x-hope-enum-item-des-cn" : "服务层"
}, {
"const" : "DOMAIN",
"description" : "Domain",
"example" : "DOMAIN",
"title" : "DOMAIN",
"x-hope-enum-item-code" : 4,
"x-hope-enum-item-des-cn" : "领域层"
} ],
"title" : "ProblemPhase",
"x-hope-rt-meta" : {
"clz" : "hope.common.wire.constant.ProblemPhase",
"protoFrom" : "hope/common/proto/constant/common.proto"
},
"x-hope-enum-type" : "true"
},
"YesNoEnum" : {
"default" : "YES",
"description" : "是选择",
"oneOf" : [ {
"const" : "YES",
"description" : "Yes",
"example" : "YES",
"title" : "YES",
"x-hope-enum-item-code" : 0,
"x-hope-enum-item-des-cn" : "是"
}, {
"const" : "NO",
"description" : "No",
"example" : "NO",
"title" : "NO",
"x-hope-enum-item-code" : 1,
"x-hope-enum-item-des-cn" : "否"
} ],
"title" : "YesNoEnum",
"x-hope-rt-meta" : {
"clz" : "hope.common.wire.constant.YesNoEnum",
"protoFrom" : "hope/common/proto/constant/common.proto"
},
"x-hope-version" : [ {
"version" : "1.1.1",
"timestamp" : "2022-12-29",
"type" : "ADD",
"message" : "very first version",
"updatedBy" : "aaron"
} ],
"x-hope-enum-type" : "true"
}
},
"responses" : { },
"parameters" : {
"PageRequest" : {
"name" : "pageRequest",
"in" : "query",
"description" : "Page Request parameter",
"schema" : {
"type" : "object",
"description" : "分页查询Parameter对象",
"properties" : {
"page" : {
"type" : "integer",
"format" : "int32",
"description" : "Zero-based page index (0..N)",
"minimum" : 0,
"title" : "page"
},
"size" : {
"type" : "integer",
"format" : "int32",
"default" : 20,
"description" : "The size of the page to be returned",
"maximum" : 1024,
"minimum" : 1,
"title" : "size"
},
"sort" : {
"type" : "array",
"description" : "Sorting criteria in the format: property,(asc|desc). \nDefault sort order is ascending. \nMultiple sort criteria are supported.",
"items" : {
"type" : "string"
}
}
},
"title" : "PageRequest"
}
}
},
"examples" : { },
"requestBodies" : { },
"headers" : { },
"securitySchemes" : { },
"links" : { },
"callbacks" : { }
},
"x-hope-project" : {
"artifact" : {
"groupId" : "com.apihug",
"artifactId" : "it-common-proto",
"version" : "0.5.2-RELEASE"
},
"name" : "hope-common-proto",
"description" : "Hope 中台服务",
"application" : "hope-common",
"packageName" : "hope.common",
"type" : "PROTO",
"domain" : "common",
"identifier" : "hope-common-proto",
"module" : "hope-common-proto",
"status" : {
"deprecated" : false,
"createdTimestamp" : "2022-11-01",
"createdBy" : "Aaron"
},
"persistence" : {
"identifyType" : "LONG",
"tenantType" : "LONG"
}
}
}© 2015 - 2025 Weber Informatics LLC | Privacy Policy