View as Json

Swagger API Documentation

The Swagger API Documentation component provides an automated way to generate and serve interactive API documentation.


Installation Guide

npx servercn-cli@latest add swagger-docs

Accessing the Docs

Once your server is running, navigate to:

http://localhost:8000/api/docs

You will see the Swagger UI dashboard where you can explore and test your API.

Don't forget to run `node src/swagger.config.ts` command and update the base url, routes... in `swagger.json` file.

File & Folder Structure

Loading files...

Installation

npx servercn-cli@latest add swagger-docs