---
meta:
 - name: keywords
   description: api typescript node.js documentation SpecTypes enum
---
# SpecTypes - @tsed/schema

## Usage

```typescript
import { SpecTypes } from "@tsed/schema";
```

> See [/packages/specs/schema/src/domain/SpecTypes.ts](https://github.com/tsedio/tsed/blob/v8.27.0/packages/specs/schema/src/domain/SpecTypes.ts#L0-L0).

## Overview

```ts
enum SpecTypes {
    JSON = "jsonschema",
    SWAGGER = "swagger2",
    OPENAPI = "openapi3",
    ASYNCAPI = "asyncapi2"
}
```

<!-- Description -->

## Description

Specification types supported by Ts.ED's schema system.

This enum defines the different API specification formats that can be generated
from Ts.ED schemas. Each type affects how schemas are serialized and which
features are available.

### Specification Types

-   **JSON**: Pure JSON Schema (no OpenAPI-specific features)
-   **SWAGGER**: Swagger 2.0 / OpenAPI 2.0 specification
-   **OPENAPI**: OpenAPI 3.x specification (recommended)
-   **ASYNCAPI**: AsyncAPI 2.x specification (for async/event-driven APIs)

### Usage

```typescript
import {SpecTypes} from "@tsed/schema";

const schema = getJsonSchema(MyModel, {
  specType: SpecTypes.OPENAPI
});
```

<!-- Members -->

## JSON

```ts
JSON = "jsonschema",
```

## SWAGGER

```ts
SWAGGER = "swagger2",
```

## OPENAPI

```ts
OPENAPI = "openapi3",
```

## ASYNCAPI

```ts
ASYNCAPI = "asyncapi2"
```