NestJS boilerplate 🎉
Home
  • English
  • Tiếng Việt
GitHub
Home
  • English
  • Tiếng Việt
GitHub
  • Setup & Development
  • Technologies
  • Architecture
  • API
  • Database
  • Security
  • Testing
  • Benchmarking
  • Deployment
  • Troubleshooting
  • FAQ
  • Convention

    • Naming cheatsheet
    • TypeScript Style Guide and Coding Conventions
    • Clean code Typescript
    • Branch conventions
    • Commit conventions
    • Linting & Formatting

API Documentation

This section provides an overview of the API documentation for the project.


  • Endpoints
  • Authentication
  • Error Handling

Endpoints

We use swagger to document the API endpoints. You can access the API documentation by visiting the /api-docs route in your browser.

For example, if your application is running on http://localhost:3000, you can access the API documentation at http://localhost:3000/api-docs.

Authentication

Error Handling

Edit this page
Last Updated:
Contributors: Lâm Ngọc Khương
Prev
Architecture
Next
Database