{"repo":"adidas/api-guidelines","free":true,"listed":false,"github":"https://github.com/adidas/api-guidelines","clone":"git clone https://github.com/adidas/api-guidelines.git","description":"adidas group API design guidelines","language":null,"stars":404,"topics":["api","guidelines","rest","rest-api","architecture","http","protocol","adidas","adidas-group","asynchronous"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"adidas API Guidelines Read online at GitBook Motivation The goal of this document is to facilitate the work and minimize the effort of all API users at adidas while protecting their investment and encouraging API First adoption. These guidelines lay down the foundation for collaboration, stability, and extensibility. Guidelines The API Guidelines are split into two main parts: General Guidelines API type-specific Guidelines REST APIs Guidelines Asynchronous APIs Guidelines The general guidelines section discusses the core principles relevant to any kind of API.  The API type-specific section further defines the guidelines specific to a given architectural style or API technique (such as REST, Kafka or GraphQL APIs). How to read the Guidelines These guidelines are available for online reading at GitBook. The source code can be found on GitHub. The CAPITALIZED words throughout these guidelines have a special meaning: Refer to RFC2119 for details. Validating your API specification against OpenAPI & Async rules In the ruleset.md file you can find a digest of API Guidelines rules which you can use to validate your API description documents. If you are using OpenAPI or AsyncAPI specification as API description format, you can also leverage the adidas-spectral.yaml ruleset to automatically lint your specification compliance using Spectral. To install Spectral, you will need Node.js and a package manager (npm or yarn). Once installed, to verify your oas or async file with spectr","default_branch":null,"files":null,"tree":[],"storefront":"/r/adidas","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/adidas/api-guidelines/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}