mirror of
https://github.com/adidas/api-guidelines.git
synced 2025-10-25 15:19:19 +00:00
GitBook: [master] 4 pages modified
This commit is contained in:
apidesigner
gitbook-bot
16
README.md
16
README.md
@@ -1,10 +1,12 @@
|
||||
# Introduction
|
||||
---
|
||||
description: Guidelines for the API design and development at adidas
|
||||
---
|
||||
|
||||
# adidas API Guidelines
|
||||
|
||||
|
||||
|
||||
## adidas API Guidelines
|
||||
|
||||
_Guidelines for API design and development at adidas_ \([Read online at GitBook](https://adidas.gitbook.io/api-guidelines/)\)
|
||||
[Read online at GitBook](https://adidas.gitbook.io/api-guidelines/)
|
||||
|
||||
### Motivation
|
||||
|
||||
@@ -42,6 +44,7 @@ Refer to [RFC2119](https://www.ietf.org/rfc/rfc2119) for details.
|
||||
_Please contact_ [_Zdenek.Nemec@externals.adidas-group.com_](mailto:Zdenek.Nemec@externals.adidas-group.com) _in the case of questions._
|
||||
|
||||
## Intended Use Cases
|
||||
|
||||
This project is intended to provide the guidelines for design & development of APIs at adidas.
|
||||
|
||||
adidas is not responsible for the usage of this software for different purposes that the ones described in the use cases.
|
||||
@@ -50,7 +53,7 @@ adidas is not responsible for the usage of this software for different purposes
|
||||
|
||||
© adidas AG
|
||||
|
||||
adidas AG publishes this software and accompanied documentation (if any) subject to the terms of the MIT license with the aim of helping the community with our tools and libraries which we think can be also useful for other people. You will find a copy of the MIT license in the root folder of this package. All rights not explicitly granted to you under the MIT license remain the sole and exclusive property of adidas AG.
|
||||
adidas AG publishes this software and accompanied documentation \(if any\) subject to the terms of the MIT license with the aim of helping the community with our tools and libraries which we think can be also useful for other people. You will find a copy of the MIT license in the root folder of this package. All rights not explicitly granted to you under the MIT license remain the sole and exclusive property of adidas AG.
|
||||
|
||||
NOTICE: The software has been designed solely for the purpose of providing API design and development guidelines. The software is NOT designed, tested or verified for productive use whatsoever, nor or for any use related to high risk environments, such as health care, highly or fully autonomous driving, power plants, or other critical infrastructures or services.
|
||||
|
||||
@@ -60,4 +63,5 @@ For further information open the [adidas terms and conditions](https://github.co
|
||||
|
||||
### License
|
||||
|
||||
[MIT](LICENSE)
|
||||
[MIT](https://github.com/adidas-group/api-guidelines/tree/657bc6fd49f1499f10c30ab18420f4bdb7cd841b/LICENSE/README.md)
|
||||
|
||||
|
||||
@@ -1,10 +1,6 @@
|
||||
# Table of contents
|
||||
|
||||
* [Introduction](README.md)
|
||||
|
||||
## Introduction
|
||||
|
||||
* [adidas API Guidelines](introduction/readme.md)
|
||||
* [adidas API Guidelines](README.md)
|
||||
|
||||
## General Guidelines
|
||||
|
||||
|
||||
@@ -1,43 +0,0 @@
|
||||
# adidas API Guidelines
|
||||
|
||||
|
||||
|
||||
## adidas API Guidelines
|
||||
|
||||
_Guidelines for API design at adidas_ \([Read online at GitBook](https://adidas-group.gitbooks.io/api-guidelines/content/)\)
|
||||
|
||||
### Motivation
|
||||
|
||||
The goal of this document is to facilitate the work and minimize the effort of all API users while protecting their investment and encouraging API adoption.
|
||||
|
||||
The guidelines lay down the foundation for collaboration, stability, and extensibility.
|
||||
|
||||
### Guidelines
|
||||
|
||||
The API Guidelines are split into two main parts:
|
||||
|
||||
* [General Guidelines](../general-guidelines/general-guidelines.md)
|
||||
* API type-specific Guidelines
|
||||
* [REST APIs Guidelines](../rest-api-guidelines/rest.md)
|
||||
* [Kafka Guidelines](../kafka-guidelines/kafka.md)
|
||||
|
||||
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 API\).
|
||||
|
||||
### How to read the Guidelines
|
||||
|
||||
These Guidelines are available for online reading at [GitBook](https://apidesigner.gitbooks.io/adidas-api-guidelines/content/) its source can be found on [GitHub](https://github.com/adidas-group/api-guidelines).
|
||||
|
||||
The CAPITALIZED words throughout these guidelines have a special meaning:
|
||||
|
||||
> ```text
|
||||
> The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
|
||||
> "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in
|
||||
> this document are to be interpreted as described in RFC2119.
|
||||
> ```
|
||||
|
||||
Refer to [RFC2119](https://www.ietf.org/rfc/rfc2119) for details.
|
||||
|
||||
### Questions & Comments
|
||||
|
||||
_Please contact_ [_Zdenek.Nemec@externals.adidas-group.com_](mailto:Zdenek.Nemec@externals.adidas-group.com) _in the case of questions._
|
||||
|
||||
@@ -1,2 +1,4 @@
|
||||
# Functionality
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user