oas3ts-generator v1.2.1

OAS3TS Generator

...

Automated tests

Never commit something that breaks the build! You can easily prevent this by linking the test script as a git pre-commit hook!

like this:

ln test .git/hooks/pre-commit

models

One of the things this generator does is emit models.

Models are emitted for schema's that have type object and that are custom objects. Models are emitted as interfaces and should never have inline types. Instead they should reference eachother.

we need two functions. One that emits the declarations as interfaces. One that resolves names for the interfaces so they can be referenced.

request component models

One model per content-type.

suffixed with RequestBodyComponentApplicationJson

response component models

One model per content-type.

suffixed with ResponseBodyComponentApplicationJson

schema models

Can be referenced by name via #/components/schema/name.

suffixed with SchemaComponent

property models

If they are part of an object that can be refenced, they can be referenced by name via #/components/.../properties/name.

suffixed with Property

oneOf (union)) models

suffixed with OneOf1

allOf (intersection)) models

suffixed with AllOf1

items (array element) models

suffixed with Item

additional property (map value) models

suffixed with AdditionalProperty

request parameters

Parameters for a request

suffixed with RequestParameters

request models

The body for a request

One model per content-type.

suffixed with RequestBodyApplicationJson

response models

The body for a response

One model per status, per content-type.

suffixed with ResponseBody200ApplicationJson