Skip to content

Commit f62f6a5

Browse files
StevenMassaroklieber
authored andcommitted
update readme to include information regarding OpenAPI V3
1 parent 6d19e31 commit f62f6a5

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,25 @@ If you would prefer that the OpenAPI 2.0 document is in JSON format you can spec
5151
</plugin>
5252
```
5353

54+
If you would prefer that the document is created to match the OpenAPI 3.0 specification you can specify it like this:
55+
```xml
56+
<plugin>
57+
<groupId>com.github.berkleytechnologyservices.restdocs-spec</groupId>
58+
<artifactId>restdocs-spec-maven-plugin</artifactId>
59+
<version>${restdocs-spec.version}</version>
60+
<executions>
61+
<execution>
62+
<goals>
63+
<goal>generate</goal>
64+
</goals>
65+
<configuration>
66+
<specification>OPENAPI_V3</specification>
67+
</configuration>
68+
</execution>
69+
</executions>
70+
</plugin>
71+
```
72+
5473
There are several other aspects you can optionally configure. Here is the full set of options with their default values:
5574

5675
```xml
@@ -72,6 +91,7 @@ There are several other aspects you can optionally configure. Here is the full
7291
<scheme>http</scheme>
7392
</schemes>
7493
<snippetDirectory>${project.build.directory}/generated-snippets</snippetDirectory>
94+
<specification>OPENAPI_V2</specification>
7595
<outputDirectory>${project.build.directory}/restdocs-spec</outputDirectory>
7696
<skip>false</skip>
7797
<format>YAML</format>
@@ -131,6 +151,6 @@ You can find a full example project here: https://github.com/BerkleyTechnologySe
131151
## Still in development
132152

133153
* Support for additional specification formats is currently in development. We plan to add
134-
support for OpenAPI 3.0 and Postman Collections.
154+
support for Postman Collections.
135155
* Currently the plugin is not available in Maven Central. However, it is available through
136156
[JitPack](https://jitpack.io/) and we do plan to eventually get it into Maven Central.

0 commit comments

Comments
 (0)