Files
defiQUG 651ff4f7eb Initial project setup: Add contracts, API definitions, tests, and documentation
- Add Foundry project configuration (foundry.toml, foundry.lock)
- Add Solidity contracts (TokenFactory138, BridgeVault138, ComplianceRegistry, etc.)
- Add API definitions (OpenAPI, GraphQL, gRPC, AsyncAPI)
- Add comprehensive test suite (unit, integration, fuzz, invariants)
- Add API services (REST, GraphQL, orchestrator, packet service)
- Add documentation (ISO20022 mapping, runbooks, adapter guides)
- Add development tools (RBC tool, Swagger UI, mock server)
- Update OpenZeppelin submodules to v5.0.0
2025-12-12 10:59:41 -08:00
..

Swagger UI Server

Interactive API documentation server for the eMoney Token Factory API.

Quick Start

# Install dependencies
pnpm install

# Start server
pnpm start

# Or in development mode
pnpm run dev

The Swagger UI will be available at:

Features

  • Interactive API documentation
  • Try-it-out functionality
  • Request/response examples
  • Authentication testing (OAuth2, mTLS, API Key)
  • Schema exploration
  • Export OpenAPI spec (JSON/YAML)

Configuration

Set environment variables:

export SWAGGER_PORT=8080  # Default: 8080

Usage

  1. Navigate to http://localhost:8080/api-docs
  2. Click "Authorize" to set up authentication
  3. Explore endpoints by expanding sections
  4. Use "Try it out" to test API calls
  5. View request/response schemas

Integration

This server can be:

  • Deployed standalone for documentation
  • Integrated into main API server
  • Used in CI/CD for API validation
  • Embedded in developer portals