TypeScript Fetch React Native API generator for OpenAPI Generator Plus

An OpenAPI Generator Plus template for a TypeScript API client using Fetch in React Native.

Features

Adds the btoa polyfill

The React Native JavaScript engine does not provide btoa. The generated client adds the abab polyfill for it. The client is otherwise the same as the client of typescript-fetch-client.

Exports one API class per operation group

The generated client exports an API class for each group of operations, such as new PetApi(configuration). It also exports a factory function and a functional form of each group. Use one of those if you prefer a function to a class.

Parses the response body

Each operation resolves with the parsed body of the default response. The generated client reads a JSON body, a text body and a binary body. It throws the Response for every other documented response.

Accepts your own fetch

Each API class takes a fetch function. Supply your own implementation for a request-scoped fetch. Supply one also to add a retry, a timeout or a request log.

Limitations

The client conformance suite records these gaps. The typescript-fetch-client2 template closes the first two of them. This repository has no React Native variant of that template.

A caller cannot read a response header

Each operation resolves with the parsed body alone. So a caller cannot read a header that the specification declares on a response, such as a page count.

A caller parses a documented error body

The generated client throws the raw Response for every documented response other than the default response. The specification may declare a model for that response. The client does not parse it, so a caller reads and parses the body itself.

The client joins an exploded delimited form array

A pipeDelimited or spaceDelimited form property with explode: true should write one pair for each element, as OpenAPI 3.1 defines. The client joins the elements whatever explode says.

Using

See the OpenAPI Generator Plus documentation for how to use generator templates.

See the typescript-fetch-client README for the config file properties, for supplying your own fetch, and for customising the templates.