JsonResponse

@tsed/schema

Usage

import { JsonResponse } from "@tsed/schema";

See /packages/specs/schema/src/domain/JsonResponse.ts.

Overview

class JsonResponse extends JsonMap<JsonResponseOptions> {
    $kind: string;
    status: number;
    constructor(obj?: Partial<JsonResponseOptions>);
    description(description: string): this;
    headers(headers: Record<string, string | JsonHeader>): this;
    content(content: Record<string, OS3MediaType<JsonSchema>>): this;
    getContent(): JsonMap<JsonMedia>;
    getMedia(mediaType: string, create?: boolean): JsonMedia;
    addMedia(mediaType: string): this;
    isBinary(): boolean;
}

Description

Represents an HTTP response definition for OpenAPI specifications.

JsonResponse defines the structure of an HTTP response including status code, description, headers, and content types. It provides a fluent API for building response metadata compatible with OpenAPI 3 specifications.

Usage

const response = new JsonResponse()
  .description("User created successfully")
  .headers({"X-Rate-Limit": "100"})
  .content({
    "application/json": {
      schema: userSchema
    }
  });

Key Features

• Status Codes: Associated HTTP status code
• Headers: Response header definitions
• Content Types: Multiple media type support
• Schema Integration: JSON schemas for response bodies

$kind

$kind: string;

status

status: number;

description

description(description: string): this;

headers

headers(headers: Record<string, string | JsonHeader>): this;

content

content(content: Record<string, OS3MediaType<JsonSchema>>): this;

getContent

getContent(): JsonMap<JsonMedia>;

getMedia

getMedia(mediaType: string, create?: boolean): JsonMedia;

addMedia

addMedia(mediaType: string): this;

isBinary

isBinary(): boolean;