The OpenAPI Parser
A native Delphi class that reads OpenAPI 3.0, 3.1 and 3.2 specifications, plus Swagger 2.0 documents it converts on the way in, giving you programmatic access to every endpoint, schema and security definition.
A native Delphi class that reads OpenAPI 3.0, 3.1 and 3.2 specifications, plus Swagger 2.0 documents it converts on the way in, giving you programmatic access to every endpoint, schema and security definition.
There is nothing to drop on a form. sgcOpenAPI registers no components and ships no design-time package, so you create TsgcOpenAPI in code, from sgcOpenAPI_Classes.pas, and read any specification into it.
ReadFromFile takes a path and Read takes the document as a string, while the command line tool downloads a URL first. JSON and YAML are both read locally, and a Swagger 2.0 document is converted to OpenAPI 3.0 locally as well.
Paths, Webhooks, Components, Security, Servers, Tags and Info are properties on the object, so operations, parameters, request and response bodies, schemas and security schemes are all reachable through a strongly typed model.
TsgcOpenAPI_Parser_Client_Pascal descends from the same class, so the generator is the reader with an emitter on top. Subclass it to produce Pascal units, or walk the model yourself for custom tooling and automation.
A $ref is kept on the object as _Ref rather than inlined, so the model is not dereferenced for you. External file and URL references are pulled in beforehand by TsgcOpenAPI_Bundle, which inlines them, remembers what it has already visited and stops at a maximum depth.
AllOf, OneOf and AnyOf are read into the schema object, together with Discriminator and its mapping, and the code generator flattens them into Pascal classes.
Warnings collects everything the reader could not honour, from a missing info object to a keyword the generator ignores, and it is cleared on every read. Line and column are reported for a YAML document that will not parse.