API Reference

This section contains comprehensive API documentation for all WealthVN services:

TypeScript APIs

Frontend command wrappers, types, and validation schemas for client-side development.

• Core Types - Fundamental type definitions used throughout the application
• Command Wrappers - Frontend-to-backend communication interface
• Validation Schemas - Zod schemas for form and data validation

Rust APIs

Backend services including Tauri commands for desktop and HTTP endpoints for web mode.

• Tauri Commands - 83+ desktop backend commands for Tauri IPC
• Web API - 50+ HTTP endpoints for web mode and server operations

OpenAPI Specification

• OpenAPI Spec - Complete OpenAPI 3.0 specification for all HTTP endpoints

Quick Navigation

By Use Case

Building a Frontend Feature?

• Start with Core Types
• Learn about Command Wrappers
• See usage examples

Adding a Backend Service?

• Implement Tauri command in src-tauri/src/commands/
• Add HTTP endpoint to src-server/src/api.rs
• Reference Tauri Commands and Web API

By Technology Stack

TypeScript/React Frontend

• Core Types
• Command Wrappers
• Validation Schemas

Rust Backend

• Tauri Commands
• Web API

Web Services

• OpenAPI Specification
• Web API

Auto-Generated Documentation

All API documentation in this section is automatically generated during the build process from:

• TypeScript type definitions and JSDoc comments
• Rust code and documentation comments
• OpenAPI specifications

This ensures documentation stays in sync with the actual code.

API Versioning

The WealthVN API follows semantic versioning:

• Major: Breaking changes to public APIs
• Minor: New features, backward compatible
• Patch: Bug fixes

See the Changelog for detailed version history.

Support & Resources

• GitHub Issues - Report bugs
• GitHub Discussions - Ask questions
• Development Guide - General development setup

---

Tip: Use the search feature (top-right) to quickly find specific APIs, commands, or types.