Field out of order for object parameter

Question

Field out of order for object parameter

arsframework opened this issue 5 years ago · 1 comments

arsframework commented 5 years ago

The parameter fields is out of order for @apiParam and @apiSuccess.

for example:

/**

@api { POST } /member/register/email Register by email
@apiSampleRequest off
@apiName io.exchange.member.controller.RegisterController.emailRegister
@APIGroup Group5
@apiHeader {String} Content-Type application/json
@apiParam { String { ^\w+((-\w+)|(.\w+))@[A-Za-z0-9]+((.|-)[A-Za-z0-9]+).[A-Za-z0-9]+$ } } email The email address
@apiParam { String { 6..6 } } verification_code The verification code
@apiParam { String } [ country ] The country
@apiParam { String } [ timezone ] The timezone
@apiParam { String { ^(?=.[0-9])(?=.[a-z])(?=.*[A-Z]).{8,20}$ } } password The password
@apiParam { String } [ identify ] Identify
@apiParam { String } [ invitation_code ] Invitation code
@apiParam { String } [ lucky_draw_id ]
@apiParam { String = H5(H5) , WEB(Web) , NATIVE(Native) , UNKNOWN(Unknown) } [ client_type ] Client type
@apiParam { String } [ geetest_user ] Geetest user
@apiParam { String } [ geetest_challenge ] Geetest challenge
@apiParam { String } [ geetest_validate ] Geetest validate
@apiParam { String } [ geetest_seccode ] Geetest seccode
@apiSuccess { Long } id The member id
@apiSuccess { String } token The token of session
@apiSuccess { String } account account
@apiSuccess { String = NORMAL , VIP } type Member type
@apiSuccess { Object } profile The member profile
@apiSuccess { String } profile.avatar The avatar of member
@apiSuccess { Object } setting The member setting
@apiSuccess { String } setting.language The custom language
@apiSuccess { Object } setting.currency The custom currency
@apiSuccess { String } setting.currency.name Currency name
@apiSuccess { String } setting.currency.icon Currency icon
@apiSuccess { String } timezone timezone
@apiSuccess { String } country country
@apiSuccessExample Response
{"id":1, "token":"", "account":"", "type":"NORMAL", "profile":{"avatar":""}, "setting":{"language":"", "currency":{"name":"", "icon":""}}, "timezone":"", "country":""}
*/

Answer 1 · 2021-09-05T15:12:58.000Z

Should be fixed in next version.