option-chain-orderbook-backend

Option Chain OrderBook Backend - REST API Server

A high-performance REST API backend for interacting with the Option Chain OrderBook library. Built with Axum for async HTTP handling and provides OpenAPI/Swagger documentation via utoipa.

Key Features

• RESTful API: Full CRUD operations for the option chain orderbook hierarchy.

• Hierarchical Access: Navigate from underlying assets down to individual option order books through a clean URL structure.

• OpenAPI Documentation: Auto-generated Swagger UI for API exploration and testing at /swagger-ui/.

• CORS Support: Cross-origin resource sharing enabled for frontend integration.

• Structured Logging: Request tracing with tower-http for debugging and monitoring.

• Thread-Safe State: Shared application state using Arc for concurrent request handling.

Architecture

The API follows the hierarchical structure of the Option Chain OrderBook library:

/api/v1/underlyings                                    → UnderlyingOrderBookManager
  └── /api/v1/underlyings/{underlying}                 → UnderlyingOrderBook
        └── /expirations                               → ExpirationOrderBookManager
              └── /expirations/{expiration}            → ExpirationOrderBook
                    └── /strikes                       → StrikeOrderBookManager
                          └── /strikes/{strike}        → StrikeOrderBook
                                └── /options/{style}   → OptionOrderBook

Module Structure

API Endpoints

Health & Statistics

Underlyings

Expirations

Strikes

Options

Example Usage

Starting the Server

# Development mode
cargo run

# With custom host/port
HOST=127.0.0.1 PORT=3000 cargo run

# Release build
cargo build --release
./target/release/option-chain-orderbook-backend

API Requests

# Create an underlying
curl -X POST http://localhost:8080/api/v1/underlyings/BTC

# Create an expiration (YYYYMMDD format)
curl -X POST http://localhost:8080/api/v1/underlyings/BTC/expirations/20240329

# Create a strike
curl -X POST http://localhost:8080/api/v1/underlyings/BTC/expirations/20240329/strikes/50000

# Add a buy order to the call option
curl -X POST http://localhost:8080/api/v1/underlyings/BTC/expirations/20240329/strikes/50000/options/call/orders \
  -H "Content-Type: application/json" \
  -d '{"side": "buy", "price": 100, "quantity": 10}'

# Get the call option quote
curl http://localhost:8080/api/v1/underlyings/BTC/expirations/20240329/strikes/50000/options/call/quote

# Get global statistics
curl http://localhost:8080/api/v1/stats

Swagger UI

Once the server is running, access the interactive API documentation at:

http://localhost:8080/swagger-ui/

Dependencies

• axum (0.8): Async web framework

• tower-http (0.6): HTTP middleware (CORS, tracing, compression)

• option-chain-orderbook: Core orderbook library

• utoipa (5.3): OpenAPI documentation generation

• utoipa-swagger-ui (8.1): Swagger UI integration

• tokio (1.42): Async runtime

• serde (1.0): Serialization/deserialization

• tracing (0.1): Structured logging

🛠 Makefile Commands

This project includes a Makefile with common tasks to simplify development. Here's a list of useful commands:

🔧 Build & Run

make build         # Compile the project
make release       # Build in release mode
make run           # Run the main binary

🧪 Test & Quality

make test          # Run all tests
make fmt           # Format code
make fmt-check     # Check formatting without applying
make lint          # Run clippy with warnings as errors
make lint-fix      # Auto-fix lint issues
make fix           # Auto-fix Rust compiler suggestions
make check         # Run fmt-check + lint + test

📦 Packaging & Docs

make doc           # Check for missing docs via clippy
make doc-open      # Build and open Rust documentation
make create-doc    # Generate internal docs
make readme        # Regenerate README using cargo-readme
make publish       # Prepare and publish crate to crates.io

📈 Coverage & Benchmarks

make coverage            # Generate code coverage report (XML)
make coverage-html       # Generate HTML coverage report
make open-coverage       # Open HTML report
make bench               # Run benchmarks using Criterion
make bench-show          # Open benchmark report
make bench-save          # Save benchmark history snapshot
make bench-compare       # Compare benchmark runs
make bench-json          # Output benchmarks in JSON
make bench-clean         # Remove benchmark data

🧪 Git & Workflow Helpers

make git-log             # Show commits on current branch vs main
make check-spanish       # Check for Spanish words in code
make zip                 # Create zip without target/ and temp files
make tree                # Visualize project tree (excludes common clutter)

🤖 GitHub Actions (via act)

make workflow-build      # Simulate build workflow
make workflow-lint       # Simulate lint workflow
make workflow-test       # Simulate test workflow
make workflow-coverage   # Simulate coverage workflow
make workflow            # Run all workflows

ℹ️ Requires act for local workflow simulation and cargo-tarpaulin for coverage.

Contribution and Contact

We welcome contributions to this project! If you would like to contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and ensure that the project still builds and all tests pass.
4. Commit your changes and push your branch to your forked repository.
5. Submit a pull request to the main repository.

If you have any questions, issues, or would like to provide feedback, please feel free to contact the project maintainer:

Contact Information

• Author: Joaquín Béjar García

• Email: jb@taunais.com

• Telegram: @joaquin_bejar

• Repository: https://github.com/joaquinbejar/Option-Chain-OrderBook-Backend

We appreciate your interest and look forward to your contributions!

License: MIT