Improvement of error responses from the API - Githubissues

TibiaData / tibiadata-api-go

TibiaData API written in Golang and deployed in container (version v3 and above).

https://api.tibiadata.com

MIT License

83 stars 27 forks source link

Improvement of error responses from the API #69

Closed tobiasehlert closed 1 year ago

tobiasehlert commented 2 years ago

We need to respond with proper error codes and messages.

Example scenarios:

404 if the resource is not found (e.g. faulty character name)
429 if the request is being throttled (tibia code is actually 403)
503 if there was some upstream issue
and also something when tibia is having maintenance.

Section that needs to be rewritten/enhanced: https://github.com/TibiaData/tibiadata-api-go/blob/ce26e500e9e611886573ec790eeb4644b6657aa9/src/webserver.go#L679-L691

This should then also be added to the documentation annotation, so that docs get automatic update too.

tobiasehlert commented 2 years ago

Separate branch (feature-error-handling) created for this.

tobiasehlert commented 1 year ago

error handling implemented by #86, closing issue.