Schema API

1. "获取模式列表"

  1. route definition
  • Url: /api/v1/schemas
  • Method: GET
  • Request: SchemasListRequest
  • Response: SchemasListResponse
  1. request definition
type SchemasListRequest struct {
	Page int `form:"page,optional"`
	PageSize int `form:"pageSize,optional"`
}
  1. response definition
type SchemasListResponse struct {
	Code int `json:"code"`
	Message string `json:"message"`
	Data interface{} `json:"data,omitempty"`
}

2. "创建模式"

  1. route definition
  • Url: /api/v1/schemas
  • Method: POST
  • Request: SchemaCreateRequest
  • Response: SchemaCreateResponse
  1. request definition
type SchemaCreateRequest struct {
	Name string `json:"name"`
	Schema interface{} `json:"schema"`
}
  1. response definition
type SchemaCreateResponse struct {
	Code int `json:"code"`
	Message string `json:"message"`
	Data interface{} `json:"data,omitempty"`
}

3. "获取模式详情"

  1. route definition
  • Url: /api/v1/schemas/:id
  • Method: GET
  • Request: SchemaDetailRequest
  • Response: SchemaDetailResponse
  1. request definition
type SchemaDetailRequest struct {
	ID string `path:"id"`
}
  1. response definition
type SchemaDetailResponse struct {
	Code int `json:"code"`
	Message string `json:"message"`
	Data interface{} `json:"data,omitempty"`
}

4. "更新模式"

  1. route definition
  • Url: /api/v1/schemas/:id
  • Method: PUT
  • Request: SchemaUpdateRequest
  • Response: SchemaUpdateResponse
  1. request definition
type SchemaUpdateRequest struct {
	ID string `path:"id"`
	Schema interface{} `json:"schema"`
}
  1. response definition
type SchemaUpdateResponse struct {
	Code int `json:"code"`
	Message string `json:"message"`
	Data interface{} `json:"data,omitempty"`
}

5. "删除模式"

  1. route definition
  • Url: /api/v1/schemas/:id
  • Method: DELETE
  • Request: SchemaDeleteRequest
  • Response: SchemaDeleteResponse
  1. request definition
type SchemaDeleteRequest struct {
	ID string `path:"id"`
}
  1. response definition
type SchemaDeleteResponse struct {
	Code int `json:"code"`
	Message string `json:"message"`
	Data interface{} `json:"data,omitempty"`
}

6. "获取模式UI配置"

  1. route definition
  • Url: /api/v1/schemas/:id/ui-config
  • Method: GET
  • Request: SchemaUIConfigRequest
  • Response: SchemaUIConfigResponse
  1. request definition
type SchemaUIConfigRequest struct {
	ID string `path:"id"`
}
  1. response definition
type SchemaUIConfigResponse struct {
	Code int `json:"code"`
	Message string `json:"message"`
	Data interface{} `json:"data,omitempty"`
}

7. "更新模式UI配置"

  1. route definition
  • Url: /api/v1/schemas/:id/ui-config
  • Method: PUT
  • Request: SchemaUIConfigUpdateRequest
  • Response: SchemaUIConfigUpdateResponse
  1. request definition
type SchemaUIConfigUpdateRequest struct {
	ID string `path:"id"`
	Config interface{} `json:"config"`
}
  1. response definition
type SchemaUIConfigUpdateResponse struct {
	Code int `json:"code"`
	Message string `json:"message"`
	Data interface{} `json:"data,omitempty"`
}

8. "验证模式数据"

  1. route definition
  • Url: /api/v1/schemas/:id/validate
  • Method: POST
  • Request: SchemaValidateRequest
  • Response: SchemaValidateResponse
  1. request definition
type SchemaValidateRequest struct {
	ID string `path:"id"`
	Data interface{} `json:"data"`
}
  1. response definition
type SchemaValidateResponse struct {
	Code int `json:"code"`
	Message string `json:"message"`
	Data interface{} `json:"data,omitempty"`
}

9. "原始模式验证"

  1. route definition
  • Url: /api/v1/schemas/raw-validate
  • Method: POST
  • Request: SchemaRawValidateRequest
  • Response: SchemaRawValidateResponse
  1. request definition
type SchemaRawValidateRequest struct {
	Schema interface{} `json:"schema"`
	Data interface{} `json:"data"`
}
  1. response definition
type SchemaRawValidateResponse struct {
	Code int `json:"code"`
	Message string `json:"message"`
	Data interface{} `json:"data,omitempty"`
}