Swagger

Make api-docs using Swagger with simple Decorators.

Config

{
  "compilerOptions":{
    "experimentalDecorators": true,
  }
}

tsconfig.json

{
  "compilerOptions": {
    "moduleResolution": "nodenext",
    "experimentalDecorators": true,
    "target": "ES5",
    "lib": [
      "DOM",
      "DOM.Iterable",
      "ESNext"
    ]
  },
}

Usage

import { nhttp, RequestEvent } from "@nhttp/nhttp";
import {
  Controller,
  Get,
} from "@nhttp/nhttp/controller";
import { 
  ApiDocument,
  ApiOperation,
  ApiResponse,
  DocumentBuilder,
  swagger, 
} from "@nhttp/nhttp/swagger";

@ApiDocument({
  name: "Doc user 1.0",
  description: "doc user description",
})
@Controller("/user")
class UserController {

  @ApiResponse(200, { description: "OK" })
  @ApiOperation({ summary: "get user" })
  @Get("/")
  getUser() {
    return "Hello";
  }

}

const app = nhttp();

app.use("/api/v1", new UserController());
// or multi controllers
// app.use("/api/v1", [new UserController(), new HomeController()]);

const document = new DocumentBuilder()
  .setInfo({
    title: "Rest APIs for amazing app",
    version: "1.0.0",
    description: "This is the amazing app",
  })
  .addServer("http://localhost:8000")
  .build();

// serve swagger
swagger(app, "/api-docs", document);

app.listen(8000);

@ApiDocument

Initial api document from controller.

@ApiDocument(desc);

@ApiBearerAuth

Add Api Bearer Auth decorators.

@ApiBearerAuth()
@ApiDocument({
  name: "Doc user 1.0",
  description: "doc user description"
})
@Controller("/user")
class UserController {...}

builder

// builder
const document = new DocumentBuilder()
  .setInfo({
    title: "Rest APIs for amazing app",
    version: "1.0.0",
    description: "This is the amazing app",
  })
  .addServer("http://localhost:3000")
  // add this
  .addBearerAuth()
  .build()

@ApiParameter

Add api parameter decorators.

@ApiDocument({
  name: "Doc user 1.0",
  description: "doc user description"
})
@Controller("/user")
class UserController {

  @ApiParameter({
    name: "id",
    in: "path"
  })
  @ApiParameter({
    name: "name",
    in: "query"
  })
  @ApiResponse(200, { description: "OK" })
  @ApiOperation({ summary: "get user id" })
  @Get("/:id")
  getUserId() {
    return "Hello";
  }
}

@ApiRequestBody

Generate request body decorators.

@ApiRequestBody(config);

Request Body (manual)

@ApiDocument({
  name: "Doc user 1.0",
  description: "doc user description"
})
@Controller("/user")
class UserController {

    @ApiRequestBody({
      description: "Save User",
      required: true,
      content: {
        "application/json": {
          schema: {
            type: "object",
            properties: {
              name: {
                type: "string"
              },
              id: {
                type: "integer"
              }
            }
          }
        }
      }
    })
    @ApiResponse(201, { description: "Created" })
    @ApiOperation({ summary: "save user" })
    @Post("/")
    save() {
      return "Success";
    }
}

Request Body (auto)

import {
  IsNumber,
  IsString
} from "npm:class-validator";
import { validationMetadatasToSchemas } from "npm:class-validator-jsonschema";

class UserCreateDto {
  @IsString()
  name!: string;

  @IsNumber()
  id!: number;
}

@ApiDocument({
  name: "Doc user 1.0",
  description: "doc user description"
})
@Controller("/user")
class UserController {

  @ApiRequestBody({
    description: "Save User",
    required: true,
    schema: UserCreateDto
  })
  @ApiResponse(201, { description: "Created" })
  @ApiOperation({ summary: "save user" })
  @Post("/")
  save() {
    return "Success";
  }
}
...

// add to options
const schemas = validationMetadatasToSchemas();
swagger(app, "/api-docs", document, { schemas });