API Documentation

Cepress Generator can automatically generate Swagger (OpenAPI) documentation for your REST API.

Swagger UI

If enabled, you can visit the Swagger UI at:

http://localhost:3000/api-docs

This provides a live, interactive view of all your endpoints, request/response types, and schemas.

How It Works

  • • Swagger config is located in src/config/swagger.js
  • • Decorated route handlers automatically generate specs
  • • You can customize descriptions, examples, and tags

Disabling Swagger

You can disable Swagger during project setup or remove the related middleware from src/app.js.