Developing Restful APIs: A Comprehensive Set of Guidelines by SailPoint, adapted from Zalando’s RESTful API Guidelines
Great RESTful APIs look like they were designed by a single team. This promotes API adoption, reduces friction, and enables clients to use them properly. To build APIs that meet this standard, and to answer many common questions encountered along the way of RESTful API development, the SailPoint API Guild has created this comprehensive set of guidelines. We have shared it with you to inspire additional discussion and refinement within and among your teams, and contribute our learnings and suggestions to the tech community at large.
Feel free to use these guidelines as a guidance for your own development. Note that we encourage our own teams to use them in order to challenge their APIs. As such, you should consider this to be a living, evolving document. We will revise and update based on our learnings and experiences.
You must have Docker installed and running before executing the below command.
make allIn order to generate custom CSS we have to use stylesheet-factory
This script clones the factory repository, installs the dependencies and generates CSS based in the zalando.scss
.scripts/build-css.shCredit goes to the Zalando Team for these guidelines. Zalando
We have made slight modifications to the Zalando guidelines to fit our company’s needs.
We have published these guidelines under the CC-BY (Creative commons Attribution 4.0) license. Please see LICENSE file.