API Guidelines
  • adidas API Guidelines
  • General Guidelines
    • Introduction
    • API First
    • Contract
    • Immutability
    • Robustness
    • Common Data Types
    • Version Control System
    • Minimal API Surface
    • Rules for Extending
    • JSON
    • Security
    • Tooling
  • REST API Guidelines
    • Introduction
    • Core REST Principles
      • OpenAPI Specification
      • API Design Platform
      • Design Maturity
      • Testing
    • Protocol
      • HTTP
      • TLS
      • Separate Concerns
      • Request Methods
      • Status Codes
    • Message
      • Message Formats
      • Content Negotiation
      • HAL
      • Problem Detail
      • Foreign Key Relations
    • Application
      • Corporate Data Model
      • Common Data Types
    • Execution
      • Pagination
      • Long Running Tasks
        • Polling
        • Callback
        • Files Upload
      • Batch Operations
      • Search Requests
      • Query Requests with Large Inputs
      • Choosing Fields and Embedded Resources
      • Localization
      • Rate Limiting
      • Caching
      • Testing Enviroments
    • Evolution
      • Naming Conventions
      • Reserved Identifiers
      • URI Structure
      • Changes and Versioning
      • Phasing out Old Versions
    • Guides
      • API Testing CI Environment
      • Complete API Development
    • API Clients
      • Loose Coupling
    • Further References
  • Asynchronous API Guidelines
    • Introduction
    • Core Asynchronous Principles
      • Event Driven Architectures
      • Messages
        • Commands
        • Queries
        • Events
          • Events as Notifications
          • Events to Replicate Data
      • Protocols
      • Coupling
      • Bounded Context
      • Stream Processing
      • Naming Conventions
      • Tooling
        • Editors
        • Command Line Interface (CLI)
        • Generators
    • Kafka Asynchronous Guidelines
      • Introduction
        • Why AsyncAPI?
      • AsyncAPI Version
      • Internal vs Public Specifications
      • Key/Value Format
      • Message Headers
      • Specification Granularity
      • Self-Contained Specifications
        • Meaningful Descriptions
      • Schema Data Evolution
        • Backward Compatibility
        • Forward Compatibility
        • Full Compatibility
      • Automatic Schema Registration
      • Contact Information
      • AsyncAPI ID
      • Servers
      • Channels
      • Schemas
      • Security Schemes
      • External Docs
Powered by GitBook
On this page
  1. REST API Guidelines

Introduction

PreviousToolingNextCore REST Principles

Last updated 5 years ago

adidas REST API Guidelines

Adidas REST API Guidelines define standards and guidelines for building REST APIs at adidas. These Guidelines have to be followed in addition to the Adidas

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 guidelines define the protocols used within the organization.

    • ********

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

    • ****

      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 qualities governance, such as testability, maintainability, extensibility, and scalability.

    • ********

      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

General API Guidelines.
Protocol level
Message level
Application level
Evolution
Execution