Minima.js

Appearance

Minima.js API

Minima.js API / @minimajs/openapi / describe

Function: describe() ​

ts
function describe<S>(options): RouteMetaDescriptor<S>;

Defined in: packages/openapi/src/describe.ts:30

Adds OpenAPI operation metadata to a route.

Type Parameters ​

S ​

S = any

Parameters ​

options ​

OperationObject

Returns ​

RouteMetaDescriptor<S>

Example ​

typescript
import { describe } from "@minimajs/openapi";

app.get("/users", describe({ summary: "List all users", tags: ["Users"] }), () => {
  return getUsers();
});

app.post("/users", describe({
  summary: "Create a user",
  description: "Creates a new user account with the provided details.",
  tags: ["Users"],
  operationId: "createUser"
}), () => {
  return createUser();
});

app.get("/legacy", describe({ deprecated: true }), () => {
  return legacyEndpoint();
});