Files
api-guidelines/rest/core-principles/introduction.md
apidesigner 958d90ea5d Creates rest/core-principles/quality.md
Auto commit by GitBook Editor
2018-06-23 12:56:08 +00:00

1.6 KiB

adidas REST API Guidelines

The adidas REST API Guidelines defines standards and guidelines for building REST APIs at adidas. These Guidelines has to be followed in addition to the General Guidelines.

The REST API Guidelines are further split into the following parts:

  • Core Principles

    REST API Guidelines Core Principles defines the rules that MUST be followed at throughout the full API lifecycle.

  • Functionality Guidelines

    • Protocol level

      Protocol guidelines define the protocols used within the organization.

    • Message level

      The Message guidelines define the structure and semantics of messages used to exchange information.

    • Application level

      The Application guidelines define the definition and use of application-specific semantics.

  • Quality Guidelines

    Evolution and Execution guidelines define the rules for achieving the desired architectural qualities of systems.

    • Evolution

      Evolution qualities governance, such as testability, maintainability, extensibility, and scalability.

    • Execution

      Execution qualities governance, such as security and usability.

  • Guides
    Guides and materials supporting the REST API Guidelines

  • API Clients

    Section dedicated to consumers of adidas APIs