This is a collection of API Style Guides used at Sabre. It's a way for us to all work better together in the service of providing a fantastic developer experience (DX) for the customers using our future Sabre APIs.
Style Guides are a way of accelerating API development by listing best-practices that we have learned, put into production, and want to adopt. Use it as a blueprint for your API development. We're promoting this as a jumping-off point to help you start working more quickly.
We have a goal of providing a common look and feel for building API interfaces used by our customers. Requests and responses are a user interface (UI) for developers. We want our APIs to collectively produce a UI that's clean, consistent, and highly capable.
The business outcome of having a set of shared API Style Guides is helping us treat APIs as products. Each API is a product, and they ought to feel as though they were all made by the same company, and look like they fit inside the same Sabre universe.
If our portfolio of APIs does this we anticipate the experience our developer customers have with our APIs will be a positive one. Developer experience (DX) for a platform company is highly crucial for adoption, engagement, and monetization. One customer-SVP noted about his engineering team selecting technology providers:
"Developers are increasingly influential, and their opinions drive changes."
The RESTful Style Guide was originally authored by Ken Tabor in August through September of 2017 while working with the Travel Network team building the Corporate Travel Services APIs. Many of you might remember reading this during that time.
The guide began heavily influenced by the Paypal API Style Guide, and from there revised and updated. This guide's content consists of:
- Industry best-practices discovered during research. Subjects studied includes many popular "Hero Companies" who are leading the way regarding APIs and platforms.
- Recommendations from Apigee white-papers. Also, including input from various online articles and conference videos from subject-matter thought-leaders.
- Updates guided by three rounds of feedback received from interested members of Sabre's architect and developer community.
Ongoing improvements are welcomed by all contributors.
The RESTful API Style Guide, being an artifact for developers, is under revision control in this git repo.
Our goal is getting your feedback to make it better, and to see how we can apply this when building customer-facing APIs.
Please read through the API Style Guides and consider if anything is confusing, missing, or can be improved. Send a pull request for a change.
This Style Guide has been a product of collaboration. We want to continue its success with your valuable contribution.
Copyright (c) 2019-2020 Sabre Corp Licensed under the MIT license.
This software and any compiled programs created using this software are furnished “as is” without warranty of any kind, including but not limited to the implied warranties of merchantability and fitness for a particular purpose. No oral or written information or advice given by Sabre, its agents or employees shall create a warranty or in any way increase the scope of this warranty, and you may not rely on any such information or advice. Sabre does not warrant, guarantee, or make any representations regarding the use, or the results of the use, of this software, compiled programs created using this software, or written materials in terms of correctness, accuracy, reliability, currentness, or otherwise. The entire risk as to the results and performance of this software and any compiled applications created using this software is assumed by you. Neither Sabre nor anyone else who has been involved in the creation, production or delivery of this software shall be liable for any direct, indirect, consequential, or incidental damages (including damages for loss of business profits, business interruption, loss of business information, and the like) arising out of the use of or inability to use such product even if Sabre has been advised of the possibility of such damages.