Swagger

This is a Julia plugin and code generator to generate your own client library with Swagger.

The goal of Swagger™ is to define a standard, language-agnostic interface to REST APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined via Swagger, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interfaces have done for lower-level programming, Swagger removes the guesswork in calling the service.

Check out OpenAPI-Spec for additional information about the Swagger project, including additional libraries with support for other languages and more.

How do I use this?

The code generation step required by this package is best done on linux. Generated julia code can of course be run on any platform.

Building

First, you need to build the Swagger Java libraries. Ensure you have Java and maven installed, and the java and mvn commands available on the path. Then, from the directory where Swagger.jl has been downloaded/installed, run this:

plugin/build.sh

A single jar file (julia-swagger-codegen-0.0.4.jar) will be produced in plugin/target.

You can now use that for codegen.

Note: problems have been reported while building with JDK 9 on MacOS likely because of this issue

Code Generation

Use the supplied script plugin/generate.sh and point it to the specification file and a configuration file. E.g.:

${SWAGGERDIR}/plugin/generate.sh -i ${SPECDIR}/${SPECFILE} -o ${GENDIR} -c config.json

where SWAGGERDIR is the location of this package SPECDIR is the directory where the openapi specification file resides SPECFILE the name of the openapi specification file from which you are generating Julia code GENDIR the directory where the generated Julia code will be written

Typically, you would generate the files into a src directory for a package. The generated code is ready to be used as a Julia module directly.

The configuration file (config.json) can have the following options:

packageName: the Julia package to generate (SwaggerClient by default)

Generated Code Structure

APIs

Each API set is generated into a file named api_<apiname>.jl. It is represented as a struct and the APIs under it are generated as methods. An API set can be constructed by providing the swagger client instance that it can use for communication.

The required API parameters are generated as regular function arguments. Optional parameters are generated as keyword arguments. Method documentation is generated with description, parameter information and return value. Two variants of the API are generated. The first variant is suitable for calling synchronously and returns a single instance of the result struct.

# example synchronous API that returns an Order instance
getOrderById(api::StoreApi, orderId::Int64)

The second variant is suitable for asynchronous calls to methods that return chunked transfer encoded responses, where in the API streams the response objects into an output channel.

# example asynchronous API that streams matching Pet instances into response_stream
findPetsByStatus(api::PetApi, response_stream::Channel, status::Vector{String})

A client context holds common information to be used across APIs. It also holds a connection to the server and uses that across API calls. The client context needs to be passed as the first parameter of all API calls. It can be created as:

Client(root::String;
    headers::Dict{String,String}=Dict{String,String}(),
    get_return_type::Function=(default,data)->default,
    timeout::Int=DEFAULT_TIMEOUT_SECS,
    long_polling_timeout::Int=DEFAULT_LONGPOLL_TIMEOUT_SECS,
    pre_request_hook::Function,
)

Where:

root: the root URI where APIs are hosted (should not end with a /)
headers: any additional headers that need to be passed along with all API calls
get_return_type: optional method that can map a Julia type to a return type other than what is specified in the API specification by looking at the data (this is used only in special cases, for example when models are allowed to be dynamically loaded)
timeout: optional timeout to apply for server methods (default Swagger.DEFAULT_TIMEOUT_SECS)
long_polling_timeout: optional timeout to apply for long polling methods (default Swagger.DEFAULT_LONGPOLL_TIMEOUT_SECS)
pre_request_hook: user provided hook to modify the request before it is sent

The pre_request_hook must provide the following two implementations:

pre_request_hook(ctx::Swagger.Ctx) -> ctx
pre_request_hook(resource_path::AbstractString, body::Any, headers::Dict{String,String}) -> (resource_path, body, headers)

In case of any errors an instance of ApiException is thrown. It has the following fields:

status::Int: HTTP status code
reason::String: Optional human readable string
resp::Downloads.Response: The HTTP Response for this call
error::Union{Nothing,Downloads.RequestError}: The HTTP error on request failure

An API call involves the following steps:

If a pre request hook is provided, it is invoked with an instance of Swagger.Ctx that has the request attributes. The hook method is expected to make any modifications it needs to the request attributes before the request is prepared, and return the modified context.
The URL to be invoked is prepared by replacing placeholders in the API URL template with the supplied function parameters.
If this is a POST request, serialize the instance of SwaggerModel provided as the body parameter as a JSON document.
If a pre request hook is provided, it is invoked with the prepared resource path, body and request headers. The hook method is expected to modify and return back a tuple of resource path, body and headers which will be used to make the request.
Make the HTTP call to the API endpoint and collect the response.
Determine the response type / model, invoke the optional user specified mapping function if one was provided.
Convert (deserialize) the response data into the return type and return.
In case of any errors, throw an instance of ApiException

Models

Each model from the specification is generated into a file named model_<modelname>.jl. It is represented as a mutable struct that is a subtype of the abstract type SwaggerModel. Models have the following methods defined:

constructor that takes keyword arguments to fill in values for all model properties.
propertynames
hasproperty
getproperty
setproperty!

In addition to these standard Julia methods, these convenience methods are also generated that help in checking value at a hierarchical path of the model.

function haspropertyat(o::T, path...) where {T<:SwaggerModel}
function getpropertyat(o::T, path...) where {T<:SwaggerModel}

E.g:

# access o.field.subfield1.subfield2
if haspropertyat(o, "field", "subfield1", "subfield2")
    getpropertyat(o, "field", "subfield1", "subfield2")
end

# access nested array elements, e.g. o.field2.subfield1[10].subfield2
if haspropertyat(o, "field", "subfield1", 10, "subfield2")
    getpropertyat(o, "field", "subfield1", 10, "subfield2")
end

Validations

Following validations are incorporated into models:

maximum value: must be a numeric value less than or equal to a specified value
minimum value: must be a numeric value greater than or equal to a specified value
maximum length: must be a string value of length less than or equal to a specified value
minimum length: must be a string value of length greater than or equal to a specified value
maximum item count: must be a list value with number of items less than or equal to a specified value
minimum item count: must be a list value with number of items greater than or equal to a specified value
enum: value must be from a list of allowed values

Validations are imposed in the constructor and setproperty! methods of models.

JuliaComputing/Swagger.jl