Utoipa for the solvers crate

.github/workflows/pull-request.yaml

@@ -178,7 +178,18 @@ jobs:
       - uses: actions/checkout@v3
         with:
           ref: ${{ github.event.pull_request.head.sha }}
+      - run: rustup toolchain install stable --profile minimal
+      - uses: Swatinem/rust-cache@v2
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: nightly
+          components: rustfmt
+      - run: cargo build -p openapi-generator
+      - name: Check for unstaged changes in generated YAML files
+        run: |
+          git diff --exit-code crates/solvers/openapi.json || { echo "::error ::OpenAPI spec contains changes: crates/solvers/openapi.json"; exit 1; }
       - run: npm install @apidevtools/swagger-cli
       - run: node_modules/.bin/swagger-cli validate crates/orderbook/openapi.yml
       - run: node_modules/.bin/swagger-cli validate crates/driver/openapi.yml
-      - run: node_modules/.bin/swagger-cli validate crates/solvers/openapi.yml
+      - run: node_modules/.bin/swagger-cli validate crates/solvers/openapi.json

crates/openapi-generator/Cargo.toml

@@ -0,0 +1,11 @@
+[package]
+name = "openapi-generator"
+version = "0.1.0"
+authors = ["Cow Protocol Developers <[email protected]>"]
+edition = "2021"
+license = "MIT OR Apache-2.0"
+
+[dependencies]
+
+[build-dependencies]
+solvers = { path = "../solvers" }

crates/openapi-generator/build.rs

@@ -0,0 +1,13 @@
+// Trick to generate the OpenAPI spec on build time.
+// See: https://github.com/juhaku/utoipa/issues/214#issuecomment-1179589373
+
+use std::fs;
+
+const SOLVERS_OPENAPI_PATH: &str = "../solvers/openapi.json";
+
+fn main() {
+    let openapi_yaml = solvers::generate_openapi_json()
+        .expect("Error generating the solvers OpenAPI documentation");
+    fs::write(SOLVERS_OPENAPI_PATH, openapi_yaml)
+        .expect("Error writing the solvers OpenAPI documentation");
+}

crates/openapi-generator/src/lib.rs

@@ -0,0 +1 @@
+

crates/solvers-dto/Cargo.toml

@@ -13,5 +13,7 @@ chrono = { workspace = true }
 hex = { workspace = true }
 number = { path = "../number" }
 serde = { workspace = true }
+serde_json = { workspace = true }
 serde_with = { workspace = true }
+utoipa = { version = "4.2.0" }
 web3 = { workspace = true }