Question 1

How do I generate a client for an OData service with Hawaii?

Accepted Answer

Specify the OData metadata URL ending with '$metadata' in the schema field of hawaii.json, such as the TripPinService example, and Hawaii will translate it to OpenAPI and generate the F# client. You can also use a local .xml file for the schema.

Question 2

Hawaii vs NSwag for F# client generation – which should I use?

Accepted Answer

Hawaii is specialized for F# with features like discriminated union responses and Fable support, offering deeper integration for F# projects. NSwag is more general-purpose and supports multiple languages, so choose Hawaii if you're all-in on F#, otherwise NSwag might be better for mixed ecosystems.

Question 3

What happens if my OpenAPI spec has missing operation IDs?

Accepted Answer

Hawaii can derive operation IDs from paths, but you can use the 'overrideSchema' configuration option to manually specify them, preventing name collisions and ensuring proper method names, as shown in the advanced examples.

Question 4

How to customize the return type of client methods in Hawaii?

Accepted Answer

Use the 'asyncReturnType' option in hawaii.json to choose between Async<'T> or Task<'T> return types, and set 'synchronous' to true for synchronous calls, as detailed in the configuration section. This allows tailoring to your application's async model.

Question 5

Does Hawaii support authentication in the generated clients?

Accepted Answer

The generated client requires you to provide your own HttpClient, so you can set authentication headers or other configurations on the HttpClient instance before passing it to the client, as demonstrated in the PetStore usage example.

Question 6

Can Hawaii handle APIs with mixed response types like binary and JSON?

Accepted Answer

Yes, Hawaii automatically generates discriminated union types to handle endpoints that return binary or typed JSON responses, ensuring type-safe handling of varied content, as mentioned in the features list.

Hawaii

What is Hawaii?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions