如何使用自動驗證restful api請求參數

本篇內容介紹了“如何使用自動驗證restful api請求參數”的有關知識，在實際案例的操作過程中，不少人都會遇到這樣的困境，接下來就讓小編帶領大家學習一下如何處理這些情況吧！希望大家仔細閱讀，能夠學有所成！

1. http api請求體的反序列化

在反序列化的過程中的針對請求數據的數據格式以及數據校驗需求，go-zero實現了自己的一套反序列化機制

1.1 數據格式以訂單order.api文件為例

type (
	createOrderReq struct {
		token     string `path:"token"`     // 用戶token
		productId string `json:"productId"` // 商品ID
		num       int    `json:"num"`       // 商品數量
	}
	createOrderRes struct {
		success bool `json:"success"` // 是否成功
	}
	findOrderReq struct {
		token    string `path:"token"`    // 用戶token
		page     int    `form:"page"`     // 頁數
		pageSize int8   `form:"pageSize"` // 頁大小
	}
	findOrderRes struct {
		orderInfo []orderInfo `json:"orderInfo"` // 商品ID
	}
	orderInfo struct {
		productId   string `json:"productId"`   // 商品ID
		productName string `json:"productName"` // 商品名稱
		num         int    `json:"num"`         // 商品數量
	}
	deleteOrderReq struct {
		id string `path:"id"`
	}
	deleteOrderRes struct {
		success bool `json:"success"` // 是否成功
	}
)

service order {
    @doc(
        summary: 創建訂單
    )
    @handler CreateOrderHandler
    post /order/add/:token(createOrderReq) returns(createOrderRes)

    @doc(
        summary: 獲取訂單
    )
    @handler FindOrderHandler
    get /order/find/:token(findOrderReq) returns(findOrderRes)

    @doc(
        summary: 刪除訂單
    )
    @handler: DeleteOrderHandler
    delete /order/:id(deleteOrderReq) returns(deleteOrderRes)
}

http api請求體的反序列化的tag有三種：

• path：http url 路徑中參數反序列化

• /order/add/1234567會解析出來token為1234567

• form：http form表單反序列化，需要 header頭添加 Content-Type: multipart/form-data

• /order/find/1234567?page=1&pageSize=20會解析出來token為1234567，page為1，pageSize為20

• json：http request json body反序列化，需要 header頭添加 Content-Type: application/json

• {"productId":"321","num":1}會解析出來productId為321，num為1

1.2 數據校驗以用戶user.api文件為例

type (
	createUserReq struct {
		age    int8   `json:"age,default=20,range=(12:100]"` // 年齡
		name   string `json:"name"`                          // 名字
		alias  string `json:"alias,optional"`                // 別名
		sex    string `json:"sex,options=male|female"`       // 性別
		avatar string `json:"avatar,default=default.png"`    // 頭像
	}
	createUserRes struct {
		success bool `json:"success"` // 是否成功
	}
)

service user {
    @doc(
        summary: 創建訂單
    )
    @handler CreateUserHandler
    post /user/add(createUserReq) returns(createUserRes)
}

數據校驗有很多種方式，包括以下但不限：

• age：默認不輸入為20，輸入則取值范圍為(12:100]，前開后閉

• name：必填，不可為空

• alias：選填，可為空

• sex：必填，取值為male或female

• avatar：選填，默認為default.png

“如何使用自動驗證restful api請求參數”的內容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業相關的知識可以關注億速云網站，小編將為大家輸出更多高質量的實用文章！