Clarify compatibility matrix

springdoc / springdoc.github.io

Library for OpenAPI 3 with spring-boot

https://springdoc.org

Apache License 2.0

9 stars 40 forks source link

Clarify compatibility matrix #25

Closed du-it closed 2 years ago

du-it commented 2 years ago

As I read it was ambigious to me what you mean with the versions you mention. Are the mentioned Spring Boot versions the minimal required version or did you only test the mentioned springdoc version against the mentioned spring Boot version. For example, is Spring 2.6.x the minimal requirement for springdoc 1.6.x? ...or is it possible to use it with 2.5.x as well (but you didn't test it)?

bnasslahsen commented 2 years ago

As you read in the introduction of this question: springdoc-openapi is compatible with spring-boot 1 and spring-boot 2. In general, you should only pick the last stable version as per today 1.6.1

The matrix describes the minimal requirements depending on the spring-boot versions. For example:

If you rely on Spring 2.6.xthe minimal requirement is 1.6.0.
But 1.6.x, will also work with previous versions as well.