You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Dec 25, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+30-34Lines changed: 30 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ This project is a code generator that focuses on supporting all openapi and json
8
8
9
9
## Overview
10
10
OpenAPI JSON Schema Generator allows auto-generation of API client libraries (SDK generation) given an
11
-
[OpenAPI Spec](https://github.com/OAI/OpenAPI-Specification) (3.0.0-[3.1.0*](#preliminary-310-spec-support) are supported).
11
+
[OpenAPI Document](https://github.com/OAI/OpenAPI-Specification) (3.0.0-[3.1.0*](#openapi-v310-support) are supported).
12
12
This project focuses on making the output 100% compliant with openapi + JSON schema specs.
13
13
The goal is to fully support everything defined in openapi + the included JSON schema specs
14
14
so developers can use all of those features.
@@ -23,7 +23,7 @@ You can join us here: https://discord.gg/mHB8WEQuYQ
23
23
24
24
## Reasons To Use the Python Generator
25
25
26
-
-[3.1.0*](#preliminary-310-spec-support)- 3.0.0 spec support
26
+
-v3.0.0 - [v3.1.0*](#openapi-v310-support)OpenAPI Specification support
27
27
- Type hints on
28
28
- schema payload inputs in SomeSchema.validate 
29
29
- Note: to make input dictionaries TypedDicts like the Money.validate example, set additionalProperties to false in the schema in your openapi document
@@ -40,7 +40,7 @@ You can join us here: https://discord.gg/mHB8WEQuYQ
40
40
- passing mypy tests means that this generator could be ported into compiled languages like java/kotlin/golang
41
41
-[Autogenerated thorough testing of json schema keyword features in models and endpoints](https://github.com/openapi-json-schema-tools/openapi-json-schema-generator/tree/master/samples/client/3_0_3_unit_test/python/test) which come from the [json schema test suite](https://github.com/json-schema-org/JSON-Schema-Test-Suite)
42
42
-[Tests are passing in CI](https://app.circleci.com/pipelines/github/openapi-json-schema-tools/openapi-json-schema-generator?branch=master)
43
-
-[Test endpoints are tagged by the relevant keyword like type/format/allOf 36 keywords and counting](https://github.com/openapi-json-schema-tools/openapi-json-schema-generator/tree/master/samples/client/3_1_0_unit_test/python/docs/apis/tags)
43
+
-[Test endpoints are tagged by the relevant keyword like type/format/allOf 39 keywords and counting](https://github.com/openapi-json-schema-tools/openapi-json-schema-generator/tree/master/samples/client/3_1_0_unit_test/python/docs/apis/tags)
44
44
- Code re-use built in from the ground up
45
45
- components/schemas/headers etc are generated as separate classes and imported when used via $ref
46
46
- Openapi spec inline schemas supported at any depth in any location
@@ -59,10 +59,10 @@ And many more!
59
59
-[Docs for the python generator](docs/generators/python.md)
-[Openapi v3.0.3 general petstore spec, general features](src/test/resources/3_0/python/petstore_customized.yaml)
62
-
-[generated v3.0.3 unit test client sample code](samples/client/3_0_3_unit_test/python)
63
-
-[Openapi json schema v3.0.3 unit test spec](src/test/resources/3_0/unit_test_spec/3_0_3_unit_test_spec.yaml)
64
62
-[generated v3.1.0 unit test client sample code](samples/client/3_1_0_unit_test/python)
65
63
-[Openapi json schema v3.1.0 unit test spec](src/test/resources/3_1/unit_test_spec/3_1_0_unit_test_spec.yaml)
64
+
-[generated v3.0.3 unit test client sample code](samples/client/3_0_3_unit_test/python)
65
+
-[Openapi json schema v3.0.3 unit test spec](src/test/resources/3_0/unit_test_spec/3_0_3_unit_test_spec.yaml)
66
66
67
67
### Can I build here?
68
68
@@ -94,35 +94,31 @@ Submit a PR if you want to add a new server scaffold, client sdk, or documentati
94
94
95
95
The OpenAPI Specification has undergone 3 revisions since initial creation in 2010. The openapi-json-schema-generator project has the following compatibilities with the OpenAPI Specification:
0 commit comments