OpenAPI Type Provider🔗ℹ

OpenAPI Type Provider is a library that generates well-typed OpenAPI client libraries, inspired by type providers in F#.

1 Overview🔗ℹ

For each route defined by the schema, a function with the name method-path will be generated. For example, for a GET request to "/weather", get-/weather will be generated. The first argument of the generated function will be a credentials struct, and the rest are parameters of the request. Calling the function will send the corresponding HTTP request with the given arguments as parameters. The functions will return a struct of an appropriate response type, specified by the schema.

For each type of response specified by the schema, a response struct is generated, named after its HTTP response code. For example, a 200 response for a GET request to the "/weather" endpoint corresponds to the get-/weather-200 struct, whose members are determined by the OpenAPI schema.

For each parameter that is of object type, a struct of the same name will be defined, using schema information from the OpenAPI specification. For example, a parameter

will expand to the following definition

#lang typed/racket

(struct Weather ([id : Integer]

[main : String]

[description : String]

[icon : String]))

In addition, functions of the form read- and write- will be generated for each of the structs that read the struct from JSExpr and write instances in JSExpr. The example above will generate

2 Authentication🔗ℹ

For authentication, different credential structs are generated based on the security scheme in the specification. Currently, only the "apiKey" scheme using query parameters is supported.