/restful-api-guidelines

A model set of guidelines for integration, APIs and development

Primary LanguageCSSCreative Commons Attribution 4.0 InternationalCC-BY-4.0

Developing APIs and integrations: A Comprehensive Set of Guidelines by Pon

0ea1c25803644664850c891ca9c3775f

Latest published version: HTML, PDF,

Purpose

Great software and software integrations look like they were designed by a single team. This promotes adoption, reduces friction, and enables clients to the software and software integrations properly. To build software and software integrations that meet this standard, and to answer many common questions encountered along the way of development, the Pon integration guild and Pon software development guild have 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.

Usage

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 software and software integratons. As such, you should consider this to be a living, evolving document. We will revise and update based on our learnings and experiences.

See BUILD documentation for technical details.

License

We have published these guidelines under the CC-BY (Creative commons Attribution 4.0) license. Please see LICENSE file.

Attribution

This work, "Pon integration guidelines", is a derivative of "Developing Restful APIs: A Comprehensive Set of Guidelines by Zalando" by Zalando, used under CC BY (Creative commons Attribution 4.0). "Pon integration guidelines" is licensed under CC BY (Creative commons Attribution 4.0) by Pon.