Type Alias FastifyApi

API specification, defined by API author

The outer structure resembles OpenAPI by defining the paths and one or more HTTP methods within each path. The actual content of the operation is what you would typically provide as schema to a Fastify route options

The paths are parameterised using {}, e.g. /somethings/{id}, similar to OpenAPI, which is different from how Fastify does it.

Example:

const myApi = {
  "/v1/somethings": {
    post: {
      body: CreateSomethingRequest,
      response: {
        200: CreateSomethingResponse
      },
    },
  },
} as const satisfies FastifyApi;
Copy