View Source OpenAPI (OpenAPI Generator v0.2.0)

Code generator for OpenAPI REST API descriptions

Note

It is not expected that clients will call functions in this module directly. Instead, consider using the mix api.gen task.

This module provides a single function, run/2, that accepts the name of a configuration profile and a list of files containing JSON or Yaml OpenAPI descriptions. It runs the three phases of code generation:

At the end, an OpenAPI.State struct is returned with all of the data that was used to generate the client code.

For more information, see the readme or the available guides on configuration, plugins, or creating a client library.

Summary

Functions

Using the given configuration profile, read the OpenAPI description contained in files and generate client code

Functions

@spec run(String.t(), [String.t()]) :: term()

Using the given configuration profile, read the OpenAPI description contained in files and generate client code