Skip to content

Reference

The exported symbols, their type definitions, and the options each one takes. For how the pieces fit together, start with the guide.

Methods

MethodWhat it does
createClientCreates a client from default fetch options. Every APIful client starts here.
createOpenAPIClientCreates a client typed from a generated OpenAPI schema, without the extension chain.
defineApifulConfigDeclares the services the generate command reads.

Types

TypeWhat it describes
ApiClientThe client itself: its default options and the with method that extends it.
HandlerExtensionBuilderAn extension that gives the client its call signature.
MethodsExtensionBuilderAn extension that adds named methods to the client.

Extensions

OpenAPI Type Helpers reach into a generated schema for the request and response types of a single operation – useful when you need to name one in a signature of your own.