search

zalando / restful-api-guidelines

A model set of guidelines for RESTful APIs and Events, created by Zalando
https://opensource.zalando.com/restful-api-guidelines/
Creative Commons Attribution 4.0 International
2.61k stars 384 forks source link

missing section on quality of service and rate limits ? #809

Open julienlau opened 3 months ago

julienlau commented 3 months ago

Hi, Thanks for sharing this documentation. I am bit surprised that there is nothing related to quality of services ? Don't you consider rate limiting as something required out of the box for any API ?

Regards

tkrop commented 3 months ago

@julienlau sorry for the late reply.

Yes, we intentionally left out service operation aspects, when we created this API guideline over 8 years ago, and concentrated on the technical aspects that need to be included in the API. So we just created rules like rule 153 to defining technical how a rate limit must be specified and added a section about performance aspects. In the last years we started to add best practice tips where we saw value, but this up-to-now does not include quality-of-service.

May be the reason for this is, that we are using our own ingress router Skipper, which allows us to simply configure rate-limits for our services while our own Kubernetes on AWS takes care to scale our micro-services smoothly.

tkrop commented 2 months ago

We will add some more remarks on the internal tooling for rate-limiting we use. Since it is open source and provides open source documentation, we think that Zalando as well as public contributors will profit from giving some more information about rate-limiting.