File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -73,13 +73,13 @@ A "bill of materials" POM for json-schema-validator dependencies.
7373
7474link:{central-search}[image:{jackson-central-badge}[]]
7575
76- json/yaml `Reader` & `Converter` based on link:{jackson}[Jackson].
76+ json/yaml `Reader`, `Writer` & `Converter` based on link:{jackson}[Jackson].
7777
7878=== link:{converter-snakeyaml}[io-snakeyaml]
7979
8080link:{central-search}[image:{snakeyaml-central-badge}[]]
8181
82- yaml `Reader` & `Converter` based on link:{snakeyaml}[snakeyaml].
82+ yaml `Reader`, `Writer` & `Converter` based on link:{snakeyaml}[snakeyaml].
8383
8484=== link:{io-interfaces}[io-interfaces]
8585
Original file line number Diff line number Diff line change 11:converter: https://github.com/openapi-processor/openapi-parser/blob/master/io-interfaces/src/main/java/io/openapiprocessor/interfaces/Converter.java
22:reader: https://github.com/openapi-processor/openapi-parser/blob/master/io-interfaces/src/main/java/io/openapiprocessor/interfaces/Reader.java
3+ :writer: https://github.com/openapi-processor/openapi-parser/blob/master/io-interfaces/src/main/java/io/openapiprocessor/interfaces/Writer.java
34
45:support: https://github.com/openapi-processor/openapi-parser/tree/master/json-schema-validator/src/main/java/io/openapiprocessor/jsonschema/reader
56:converter-jackson: https://github.com/openapi-processor/openapi-parser/tree/master/io-jackson
@@ -17,6 +18,12 @@ the link:{reader}[`Reader`] interface is used to read OpenAPI json/yaml document
1718
1819 InputStream read(URI uri) throws IOException;
1920
21+ == Reader
22+
23+ the link:{writer}[`Writer`] interface is used to write OpenAPI json/yaml documents:
24+
25+ void write(Object document) throws IOException;
26+
2027== Converter
2128
2229the link:{converter}[`Converter`] interface is used to convert a json/yaml document into a java `Object` tree. The tree structure should be a `Map<String, Object>`.
Original file line number Diff line number Diff line change 11:openapi: https://www.openapis.org/
2+ :overlay: https://spec.openapis.org/overlay/v1.0.0.html
23:converter-jackson: https://github.com/openapi-processor/openapi-parser/tree/master/io-jackson
34:converter-snakeyaml: https://github.com/openapi-processor/openapi-parser/tree/master/io-snakeyaml
45
@@ -9,7 +10,7 @@ It is usable, but has the following limitations at the moment:
910* it does support most but not all OpenAPI object properties
1011* minimal documentation (just this README)
1112
12- source code gifts (i.e pull requests) are welcome :-)
13+ source code gifts (i.e. pull requests) are welcome :-)
1314
1415== openapi-parser & validator
1516
@@ -21,6 +22,9 @@ a Java 11 based link:{openapi}[OpenAPI] 3.0.x & 3.1 parser with validation and p
2122** JSON schema draft-2020-12 validation of OpenAPI 3.1
2223* separate apis for OpenAPI 3.0 & 3.1
2324* easily get resolved $ref object
25+ * bundle multi-file OpenAPI documents (experimental)
26+ * write bundled single-file OpenAPI document (json or yaml) (experimental)
27+ // * apply link:{overlay}[Overlays] (experimental)
2428* minimal dependencies
2529* pluggable document reader
2630* pluggable json/yaml converter
You can’t perform that action at this time.
0 commit comments