actix-swagger

(β˜… 110)

Swagger code generator for actix-web framework

  • .gitignore
  • .rustfmt.toml
  • Cargo.lock
  • Cargo.toml
  • LICENSE
  • Makefile.toml
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/oapigen/actix-swagger

Downloads the entire project code from GitHub to your computer.

cd actix-swagger

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
cargo install cargo-swagg

Builds and installs the package published on crates.io β€” no need to clone the repo yourself.

cargo install cargo-make

Builds and installs the package published on crates.io β€” no need to clone the repo yourself.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cargo install cargo-swagg

Builds and installs the package published on crates.io β€” no need to clone the repo yourself.

cargo add actix-swagger

Type this command into your terminal and run it.

cargo swagg ./openapi.yaml --out-file ./src/api.rs

Type this command into your terminal and run it.

cargo install cargo-make

Builds and installs the package published on crates.io β€” no need to clone the repo yourself.

cargo make

Type this command into your terminal and run it.

βœ… If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

// repository documentation