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
+33-1Lines changed: 33 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,39 @@ OpenAPI JSON Schema Generator allows auto-generation of API client libraries (SD
21
21
22
22
- python
23
23
24
-
## Can I build here?
24
+
### Mission Statement
25
+
26
+
This repo is based on v6.2.0 of OpenAPI Generator.
27
+
This project focuses on making the output 100% compliant with JSON schema as part of the
28
+
OpenAPI 3.1 specification with a focus on complex cases (top-down approach). The goal is
29
+
to fully support everything defined in JSON schema so that developers can leverage JSON
30
+
schema as well as OpenAPI specification in their API design. Building here allows for
31
+
more rapid progress supporting new features in OpenAPI 3.X without having to support
32
+
many older generators which don't use the new features.
33
+
34
+
### Reasons To Use the Python Generator
35
+
36
+
-[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/openapi3/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)
37
+
-[Tests are passing in CI](https://app.circleci.com/pipelines/github/openapi-json-schema-tools/openapi-json-schema-generator?branch=master)
38
+
-[Test endpoints are tagged by the relevant keyword like type/format/allOf 25+ keywords and counting](https://github.com/openapi-json-schema-tools/openapi-json-schema-generator/tree/master/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags)
39
+
- Run time type checking and validation checking
40
+
- If needed, validation of some json schema keywords can be deactivated via a configuration class
41
+
- Openapi spec inline schemas supported of any depth
42
+
- Type hints for all model inputs
43
+
- Payload values are not coerced when validated, so a datetime value can pass other validations that describe the payload only as type string
44
+
- Type hints for accessing properties in object instances so some_val in some_val = some_inst['someKey'] will have the correct type hint
45
+
- Type hints for accessing array items in array instances so some_val in some_val = array_inst[0] will have the correct type hint
46
+
- Endpoints have input and response type hints
47
+
- String transmission of numbers supported with type: string, format: number, value can be accessed as a Decimal with inst.as_decimal_oapg
48
+
- Format support for: int32, int64, float, double, binary, date, datetime
49
+
- Multiple content types supported for request and response bodies
50
+
- Endpoint response always also includes the urllib3.HTTPResponse
51
+
- Endpoint response deserialization can be skipped with the skip_deserialization argument
52
+
- Invalid (in python) property names supported like self, from etc
53
+
54
+
And many more! The docs for that generator are [here](https://github.com/openapi-json-schema-tools/openapi-json-schema-generator/blob/master/docs/generators/python.md)
55
+
56
+
### Can I build here?
25
57
26
58
Yes! Contributions are welcome.
27
59
If you want to build a new server or client or documentation generator you are welcome to here.
0 commit comments