Skip to content

Commit 225f8b1

Browse files
committed
update readme
1 parent e8b9884 commit 225f8b1

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

README.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,41 @@
44
[![build](https://github.com/dwickern/swagger-play/workflows/build/badge.svg)](https://github.com/dwickern/swagger-play/actions)
55
[![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)
66

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

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

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

16-
// for Play 2.8.8 or later:
16+
// for Play 2.8.8 - 2.8.x:
1717
libraryDependencies ++= Seq(
18-
"com.github.dwickern" %% "swagger-play2.8" % "3.1.0",
18+
"com.github.dwickern" %% "swagger-play2.8" % "4.0.0",
1919
"io.swagger" % "swagger-core" % "1.6.2",
2020
"com.fasterxml.jackson.module" %% "jackson-module-scala" % "2.11.1"
2121
)
22+
23+
// for Play 2.9:
24+
libraryDependencies += "com.github.dwickern" %% "swagger-play2.9" % "4.0.0"
25+
26+
// for Play 3.0:
27+
libraryDependencies += "com.github.dwickern" %% "swagger-play3.0" % "4.0.0"
2228
```
2329

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

26-
| playframework | jackson | swagger-core |
27-
|---------------|---------|--------------|
28-
| 2.7 | 2.9.x | 1.5.24 |
29-
| 2.8.0-2.8.7 | 2.10.x | 1.6.0-1.6.1 |
30-
| 2.8.8 | 2.11.x | 1.6.2 |
33+
| playframework | jackson | swagger-core |
34+
|---------------|---------|----------------|
35+
| 2.7 | 2.9.x | 1.5.24 |
36+
| 2.8.0 - 2.8.7 | 2.10.x | 1.6.0 - 1.6.1 |
37+
| 2.8.8 - 2.8.x | 2.11.x | 1.6.2 - 1.6.5 |
38+
| N/A | 2.12.x | N/A |
39+
| N/A | 2.13.x | 1.6.6 - 1.6.8 |
40+
| 2.9.0 - 3.0.0 | 2.14.x | 1.6.9 - 1.6.11 |
41+
| N/A | 2.15.x | 1.6.12 |
3142

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

0 commit comments

Comments
 (0)