Skip to main content
Home
Browse packagesDocsSign in

@dklab/oak-routing-ctrl@0.16.1
Built and signed on GitHub Actions

latest
Thesephi/oak-routing-ctrl

TypeScript Decorators for easy scaffolding API services with the oak framework (jsr:@oak/oak)

This package works with Cloudflare Workers, Node.js, Deno, Bun
This package works with Cloudflare Workers
This package works with Node.js
This package works with Deno
This package works with Bun
JSR Score
100%
Published
a week ago (0.16.1)
type alias OakOpenApiSpec

Open API Schema interface, usable when composing the request/response schema for a REST endpoint (declared when using the decorators such as Get, Post, etc.)

Examples

Example 1

import { Get } from "@dklab/oak-routing-ctrl"

const GetItemsSchema: OakOpenApiSpec = {
  responses: {
    "200": { "description": "OK" }
  }
}

// later inside the Controller Class
class ExampleClass {
  ;@Get("/", GetItemsSchema)
  async getSomething() {
    //
  }
}

Definition

Omit<RouteConfig,
"method"
| "path"
| "responses"
| "requestBody"
> & { request?: RouteConfig["request"]; responses?: { [statusCode: string]: ResponseConfig; }; }

New Ticket: Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

deno add jsr:@dklab/oak-routing-ctrl

Import symbol

import { type OakOpenApiSpec } from "@dklab/oak-routing-ctrl";
or

Import directly with a jsr specifier

import { type OakOpenApiSpec } from "jsr:@dklab/oak-routing-ctrl";

Add Package

pnpm i jsr:@dklab/oak-routing-ctrl
or (using pnpm 10.8 or older)
pnpm dlx jsr add @dklab/oak-routing-ctrl

Import symbol

import { type OakOpenApiSpec } from "@dklab/oak-routing-ctrl";

Add Package

yarn add jsr:@dklab/oak-routing-ctrl
or (using Yarn 4.8 or older)
yarn dlx jsr add @dklab/oak-routing-ctrl

Import symbol

import { type OakOpenApiSpec } from "@dklab/oak-routing-ctrl";

Add Package

vlt install jsr:@dklab/oak-routing-ctrl

Import symbol

import { type OakOpenApiSpec } from "@dklab/oak-routing-ctrl";

Add Package

npx jsr add @dklab/oak-routing-ctrl

Import symbol

import { type OakOpenApiSpec } from "@dklab/oak-routing-ctrl";

Add Package

bunx jsr add @dklab/oak-routing-ctrl

Import symbol

import { type OakOpenApiSpec } from "@dklab/oak-routing-ctrl";