Question 1

How do I generate a client for a FastAPI app running on localhost?

Accepted Answer

Use the generate.sh script with -i http://localhost/openapi.json and -p for package name. If both server and generator are in Docker, add --map-localhost to automatically map to host.docker.internal for connectivity.

Question 2

FastAPI client generator vs openapi-generator for Python?

Accepted Answer

FastAPI Client Generator is optimized for FastAPI with better type safety and IDE integration, while openapi-generator is more general-purpose but may produce less Pythonic code. Choose based on whether your API uses FastAPI and prioritizes type annotations.

Question 3

Does it support async API calls?

Accepted Answer

Yes, it provides asynchronous interfaces via AsyncApis for awaitable calls, as shown in the usage example with async_apis.pet_api.get_pet_by_id, making it suitable for modern async/await patterns.

Question 4

How to add custom authentication to the generated client?

Accepted Answer

Extend the ApiClient with request middleware support, which allows custom authentication logic. The README mentions extensible architecture, but specific examples are limited, so you may need to refer to the codebase.

Question 5

What OpenAPI features are not supported?

Accepted Answer

The README explicitly states discriminator fields are not yet supported, and while it aims for broad compatibility, it works best with FastAPI-generated specs, potentially missing edge cases from other generators.

Question 6

Can I publish the generated client as a PyPI package?

Accepted Answer

Yes, use the --with-meta flag during generation to include package metadata like setup.py, facilitating distribution or publishing, as described in the generation details section.

FastAPI Client Generator

What is FastAPI Client Generator?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions