What is OpenAPI?

OpenAPI is a standard format for describing HTTP APIs. It’s a single file - usually openapi.json or openapi.yaml - that lists every endpoint your API exposes: the URL, the method, the parameters, and the shape of the response.

Think of it as a table of contents for your API that both humans and machines can read.

Why does Automiel need it?

Automiel uses your OpenAPI spec to understand your API without ever reading your source code. From the spec, it knows:

• What endpoints exist (GET /users/{id}, POST /orders, …)
• What parameters each endpoint expects (type, whether required, valid values)
• What the response looks like

That’s everything needed to generate accurate, type-safe tools for AI assistants.

Do I need to write it by hand?

No. Most frameworks generate the spec automatically from your code. You just need to expose it at a public URL and paste that URL into Automiel.

See the guides for your framework:

• FastAPI - Python
• NestJS - TypeScript
• Hono - TypeScript
• Fastify - TypeScript
• Express - TypeScript
• tRPC - TypeScript
• Django REST Framework - Python
• Flask - Python
• Gin - Go
• Rails - Ruby
• Spring Boot - Java / Kotlin
• Laravel - PHP