Warp->Axum + OpenAPI documentation

.cargo/config.toml

@@ -74,3 +74,8 @@ rustflags = [
   "-C",
   "link-args=--export=__tls_base",
 ]
+
+# Cargo aliases for xtask
+[alias]
+xtask = "run --package xtask --"
+x-openapi-gen = "run --package xtask --features xtask/openapi-gen -- openapi"

.github/workflows/docs.yaml

@@ -43,15 +43,15 @@ jobs:
         run: make docs-install
 
       - name: Setup Rust
-        uses: dtolnay/rust-toolchain@stable
+        uses: ./.github/actions/setup-rust
         with:
-          components: rustfmt
           # This should be in line with the verison in:
           # - Makefile
           # - ./github/workflows/docs.yaml
           # - ./github/workflows/fmt.yaml
           # - ./github/workflows/lint.yaml
           toolchain: nightly
+          cache-prefix: docs
 
       - name: Verify code references in documentation (PR mode)
         if: github.event_name == 'pull_request'
@@ -130,15 +130,10 @@ jobs:
         run: make docs-install
 
       - name: Setup Rust
-        uses: dtolnay/rust-toolchain@stable
+        uses: ./.github/actions/setup-rust
         with:
-          components: rustfmt
-          # This should be in line with the verison in:
-          # - Makefile
-          # - ./github/workflows/docs.yaml
-          # - ./github/workflows/fmt.yaml
-          # - ./github/workflows/lint.yaml
           toolchain: nightly
+          cache-prefix: docs
 
       - name: Build documentation
         run: make docs-build

.gitignore

@@ -15,6 +15,7 @@ tests.tsv
 
 # Generated API docs should not be committed
 website/static/api-docs/
+website/static/openapi/openapi.json
 
 crates/ledger/3.0.0mainnet
 crates/ledger/berkeley-devnet

CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### Added
+
+- **Documentation**: add interactive OpenAPI documentation (Swagger UI, Stoplight
+  Elements, Scalar) to the website, with `cargo xtask` for static spec generation
+  ([#2119](https://github.com/o1-labs/mina-rust/pull/2119))
+- **Node**: add OpenAPI documentation endpoints (`/api-docs/*`)
+  ([#2119](https://github.com/o1-labs/mina-rust/pull/2119))
+
 ### Changed
 
 - **CI**: Add `merge_group` trigger to workflows for merge queue support
@@ -23,6 +31,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - **Frontend**: remove old code adding so-called "deployment" information,
   leaking engineer information
   ([#2092](https://github.com/o1-labs/mina-rust/pull/2092))
+- **Node**: migrate HTTP server from warp to axum
+  ([#2119](https://github.com/o1-labs/mina-rust/pull/2119))
 
 ### Dependencies