Beignet API reference
    Preparing search index...

    Function contractsToOpenAPI

    • Convert contracts to an OpenAPI 3.1 document.

      Parameters

      Returns OpenAPIObject

      OpenAPI 3.1 document object

      import { contractsToOpenAPI } from "@beignet/core/openapi";
      import { getTodo, listTodos } from "./contracts";

      const spec = contractsToOpenAPI(
      [getTodo, listTodos],
      {
      title: "Todo API",
      version: "1.0.0",
      servers: [{ url: "https://api.example.com" }],
      }
      );