Question 1

How do I validate my OpenAPI spec against adidas guidelines?

Accepted Answer

Install Spectral CLI via npm or yarn, then run 'spectral lint <your-file> --ruleset adidas-spectral.yaml' to automatically check compliance with the guidelines. This leverages the provided ruleset for efficient linting.

Question 2

What's the difference between adidas API guidelines and Google's API design guide?

Accepted Answer

adidas guidelines are enterprise-focused with specific Spectral rulesets for automated validation, while Google's guide is more general and widely adopted. adidas also includes asynchronous API coverage, whereas Google's is primarily REST-oriented.

Question 3

Does adidas API guidelines support GraphQL?

Accepted Answer

No, the current guidelines explicitly cover REST and asynchronous APIs only; GraphQL is not included in the automated validation or detailed rules, limiting its use for GraphQL-based projects.

Question 4

How can I contribute to the adidas API guidelines?

Accepted Answer

Use GitHub collaboration tools like issues, pull requests, and discussions as mentioned in the README. The project is open source under MIT license, allowing community contributions to improve the guidelines.

Question 5

Are these guidelines mandatory for external developers using adidas APIs?

Accepted Answer

Primarily intended for internal adidas teams, but external developers can refer to them for consistency. Always check adidas's official API documentation for specific requirements, as these guidelines may not be enforced externally.

Question 6

How to integrate Spectral linting into a CI/CD pipeline?

Accepted Answer

Add the Spectral lint command as a step in your pipeline script—for example, in GitHub Actions, create a job that installs Spectral via npm and runs the lint against your API specs during build or pull request checks.

Adidas REST API Guidelines

What is Adidas REST API Guidelines?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions