Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dwickern committed Nov 4, 2023
1 parent e8b9884 commit 225f8b1
Showing 1 changed file with 21 additions and 10 deletions.
31 changes: 21 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,41 @@
[![build](https://github.com/dwickern/swagger-play/workflows/build/badge.svg)](https://github.com/dwickern/swagger-play/actions)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.dwickern/swagger-play2.8_2.13/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.github.dwickern/swagger-play2.8_2.13)

This fork is cross-compiled for Play 2.7 and 2.8 with Scala 2.12 and 2.13.
This fork is cross-compiled for Play 2.7 - 3.0

```sbt
// for Play 2.7.3 - 2.7.9:
libraryDependencies += "com.github.dwickern" %% "swagger-play2.7" % "3.1.0"
libraryDependencies += "com.github.dwickern" %% "swagger-play2.7" % "4.0.0"

// for Play 2.8.0 - 2.8.7:
libraryDependencies += "com.github.dwickern" %% "swagger-play2.8" % "3.1.0"
libraryDependencies += "com.github.dwickern" %% "swagger-play2.8" % "4.0.0"

// for Play 2.8.8 or later:
// for Play 2.8.8 - 2.8.x:
libraryDependencies ++= Seq(
"com.github.dwickern" %% "swagger-play2.8" % "3.1.0",
"com.github.dwickern" %% "swagger-play2.8" % "4.0.0",
"io.swagger" % "swagger-core" % "1.6.2",
"com.fasterxml.jackson.module" %% "jackson-module-scala" % "2.11.1"
)

// for Play 2.9:
libraryDependencies += "com.github.dwickern" %% "swagger-play2.9" % "4.0.0"

// for Play 3.0:
libraryDependencies += "com.github.dwickern" %% "swagger-play3.0" % "4.0.0"
```

Note that Jackson is generally not binary compatible between minor releases.
Make sure all of your dependencies (including other third-party libraries) use a compatible version of Jackson:

| playframework | jackson | swagger-core |
|---------------|---------|--------------|
| 2.7 | 2.9.x | 1.5.24 |
| 2.8.0-2.8.7 | 2.10.x | 1.6.0-1.6.1 |
| 2.8.8 | 2.11.x | 1.6.2 |
| playframework | jackson | swagger-core |
|---------------|---------|----------------|
| 2.7 | 2.9.x | 1.5.24 |
| 2.8.0 - 2.8.7 | 2.10.x | 1.6.0 - 1.6.1 |
| 2.8.8 - 2.8.x | 2.11.x | 1.6.2 - 1.6.5 |
| N/A | 2.12.x | N/A |
| N/A | 2.13.x | 1.6.6 - 1.6.8 |
| 2.9.0 - 3.0.0 | 2.14.x | 1.6.9 - 1.6.11 |
| N/A | 2.15.x | 1.6.12 |

This library is also available as a SBT plugin: [sbt-swagger-play](https://github.com/dwickern/sbt-swagger-play)

Expand Down

0 comments on commit 225f8b1

Please sign in to comment.