⚡
LightningUserVault
  • Introduction
  • GETTING STARTED
    • Quickstart Guide
      • Docker Deployment
      • Local Deployment
    • Server Commands
  • Architecture
    • Overview
    • API Server
    • Data Storage:
      • Key-Value Databases
        • Pebbel DB
      • SQL Databases
        • PostgreSQL
    • Caching Mechanism:
      • MEMCACHE
  • Additional Features
    • Swagger
    • Postman Collection
    • Prometheus
    • Grafana
  • Releases
  • Contribution
Powered by GitBook
On this page
  1. Additional Features

Swagger

At LightningUserVault, we believe in clarity and ease of use. To ensure our API is transparent and accessible, we've integrated Swagger, a tool for API documentation.

🌐 Accessing Swagger

Once the application is up and running, you can explore our API documentation by visiting

http://localhost:<SERVER_PORT>/swagger/index.html

Just replace <SERVER_PORT> with the port your server is operating on, typically 8080 by default.

🛠️ Benefits

  • Interactive UI: Test and understand API endpoints directly from your browser.

  • Detailed Overview: View request methods, parameters, and response models for each endpoint.

  • Real-time Testing: Use the "Try it out" feature to execute requests instantly.

PreviousMEMCACHENextPostman Collection

Last updated 1 year ago