restful-api-guidelines
restful-api-guidelines copied to clipboard
zalando
A model set of guidelines for RESTful APIs and Events, created by Zalando
addresses issue: https://github.com/zalando/restful-api-guidelines/issues/685
While `\uxxxx` are valid characters in a JSON string, they can create failures when leaving the JSON context, e.g. by writing to a database or piping it to through tools....
Rule headings could contain a variety of small icons at the end of them for quick copy-pasting into documents, chats, and comments. I've thought about two specifically for now -...
https://github.com/zalando/restful-api-guidelines/blob/4d7b9d0ffd2ff65bd0ad5252c367aa49beac4dae/chapters/pagination.adoc#should-use-pagination-links-where-applicable The "You should avoid providing a total count..." remark in that section can arguably be thought to apply to the whole concept of pagination instead of just the "SHOULD...
We use different layout formats for standard guideline elements like 'Exception:', 'Hint:', 'Note:', 'Remark:', 'Example:', 'Tip', 'Reasoning:', 'Warning:', 'Important:', 'Caution:'. Additionally, the elements are partially redundant with unclear 'didactic purpose'....
**Problem** Pages 10 (durable references) and 44/45 (common method properties table) of the PDF show some pieces of text as plain HTML instead of formatted properly. **Analysis** When running the...
The Event Guidelines partially are designed to be generic, i.e. agnostic with respect to the Event Registry and Event Bus used to exchange events (e.g. Nakadi or AWS SQS). On...
We want to have a general guideline about usage of API gateways. The main question is whether we generally want to describe the API "before" or "behind" the gateway? *...
Improve guidance for return code usage for (robust) create. * 201 (success, created) vs. return code 200 (success, robust repetition) vs. 409 (error, no robust repetition) * 20x are idempotent...
Our **HAL**-based rule [Should: Allow Optional Embedding of Sub-Resources](https://opensource.zalando.com/restful-api-guidelines/#158) predates our new [Must: Use Common Hypertext Controls](https://opensource.zalando.com/restful-api-guidelines/#164) guideline and may not fit perfectly in this new world. I'm wondering whether...