Skip to main content

OpenAPI Specification

Complete OpenAPI 3.0 specification for all HTTP endpoints.

Note: This documentation is auto-generated from API definitions. Run pnpm docs:generate to update.

Overview

The OpenAPI specification provides a machine-readable definition of the WealthVN HTTP API.

Specification Location

  • Web API: src-server/src/api.rs
  • OpenAPI Spec: docs/docusaurus/docs/api/openapi/spec.json

Using the Specification

You can use this OpenAPI specification with various tools:

  • Swagger UI - Interactive API documentation
  • Postman - API testing and development
  • Code Generators - Auto-generate client libraries
  • API Documentation Tools - Generate custom documentation

Getting Started

See the Development Guide for setup instructions.