Skip to content

routes.md

Latest commit

 

History

History
39 lines (30 loc) · 1.1 KB

routes.md

File metadata and controls

39 lines (30 loc) · 1.1 KB

Routes

Each API route is defined in a separate file within a specific directory (by default, ./api). Here's an example:

// api/index.ts
import { withWinterSpec } from "../with-winter-spec"
import { z } from "zod"

export default withWinterSpec({
  auth: "none",
  methods: ["POST"],
  jsonBody: z.object({
    a: z.number(),
    b: z.number(),
  }),
  jsonResponse: z.object({
    sum: z.number(),
  }),
})((req, ctx) => {
  const { a, b } = await req.jsonBody

  return ctx.json({
    sum: a + b,
  })
})

Zod is used for validation. By default, both input and output (Response.json()) are validated against the provided schemas. See the docs on createWithWinterSpec() if you want to disable this.

File routing

WinterSpec loosely follows Next.js's route convention. For example:

  • /api/health.ts -> GET /health
  • /api/resource/[id].ts -> GET /resource/:id
  • /api/resource/[id]/actions/[...action].ts -> GET /resource/:id/actions/:action*

Path parameters are automatically parsed and added to the req.pathParams object.