multijet
  • ✈️Welcome to Multijet
  • Getting started
    • 👀Overview
    • 🆕Create a project
    • 🗂️Directory structure
    • 💡Core concepts
      • Workspaces
      • OpenAPI
    • 💻Multijet CLI
    • 📦External modules
    • 📋Default commands
    • ✨Style and structure guide
  • Configuration
    • ⚙️Project configuration
    • 🗃️Microservices and libs
    • ⚡Turborepo
    • 🏗️Build configuration
    • 🌍Environment variables
  • Deploy
    • 🐳Docker
    • 🐢AWS Lambda
  • Next features
Powered by GitBook
On this page
  1. Getting started
  2. Core concepts

OpenAPI

PreviousWorkspacesNextMultijet CLI

Last updated 1 year ago

The development flow of a Multijet project is based around the OpenAPI definition file, located in configs/openapi.json.

To know more about OpenAPI, head to the .

Multijet only supports OpenAPI version 3.x

Code generation

To generate all the required models from the OpenAPI file, simply run this command in the root of your project:

npm run openapi:generate

This script will generate all the Typescript interfaces and models based on the API definition, including:

  • Component schemas

  • Path and query params

  • Requests and responses body

  • Routes

The base schemas are generated in libs/models and can be imported from anywhere by just installing @libs/models. Everything else are Fastify specific types and located in libs/fastify-utils/generated.

The generated files are ignored by Git and should never be included in the repository.

💡
official specification