[v2] Standard JSON Response Format

[harshkhandeparkar]

Currently, the format of the responses returned by endpoints is not standard. In some cases, a plain text response is returned, whereas in some cases, it is JSON. Also, the text in the response is different. (For example, there is no standard format for error responses)

A standard JSON format would be better for responses of every endpoint. Please share any ideas below.

[harshkhandeparkar]

@Alph3ga @YoganshSharma do you have any suggestions for this?

[YoganshSharma]

How about adding a response struct similar to this

type HTTPError struct {
    Code    int    `json:"code" example:"400"`
    Message string `json:"message" example:"status bad request"`
}

And refactoring utils.LogWarnAndRespond and utils.LogErrAndRespond to use this instead. Some places where these util functions should be used, but they aren't. That also needs to be fixed.

[harshkhandeparkar]

How about adding a response struct similar to this

type HTTPError struct {
  Code    int    `json:"code" example:"400"`
  Message string `json:"message" example:"status bad request"`
}

Works.

And refactoring utils.LogWarnAndRespond and utils.LogErrAndRespond to use this instead. Some places where these util functions should be used, but they aren't. That also needs to be fixed.

Which places? (apart from #130 ?)

[YoganshSharma]

• In project_reg.go: https://github.com/kossiitkgp/KWoC-Backend/blob/00662b266ce2b7cd487a1880efd9fb0dc7c206ee/controllers/project_reg.go#L58-L59
• In project_update.go: https://github.com/kossiitkgp/KWoC-Backend/blob/00662b266ce2b7cd487a1880efd9fb0dc7c206ee/controllers/project_update.go#L60-L61

[YoganshSharma]

ig we should generalize HTTPError to a more general name like HTTPMessage and use it wherever we are return status code 200 and a message like https://github.com/kossiitkgp/KWoC-Backend/blob/00662b266ce2b7cd487a1880efd9fb0dc7c206ee/controllers/mentor.go#L87-L88

[harshkhandeparkar]

• In project_reg.go: https://github.com/kossiitkgp/KWoC-Backend/blob/00662b266ce2b7cd487a1880efd9fb0dc7c206ee/controllers/project_reg.go#L58-L59

  • In project_update.go: https://github.com/kossiitkgp/KWoC-Backend/blob/00662b266ce2b7cd487a1880efd9fb0dc7c206ee/controllers/project_update.go#L60-L61

Interesting

[harshkhandeparkar]

do you want to work on this? self assign if yes. also ig doing this before #150 would be better