MENU
  1. ホーム
  2. Rust
  3. RustでWeb APIドキュメントをOpenAPIで自動生成する方法

RustでWeb APIドキュメントをOpenAPIで自動生成する方法

Rust

RustでWeb APIを開発する際、ドキュメントの管理は非常に重要です。正確で見やすいドキュメントがあれば、開発者やユーザーがAPIの仕様を理解しやすくなり、チームのコミュニケーションもスムーズになります。しかし、手動でドキュメントを作成・更新するのは手間がかかり、コードの変更に追従しづらい問題があります。

この課題を解決する方法の一つが自動生成です。Rustでは、OpenAPI（旧Swagger）を活用してWeb APIのドキュメントを自動生成することが可能です。utoipaやrocket、actix-webといったクレートやフレームワークを利用すれば、コードから直接ドキュメントを生成し、常にAPIの最新仕様を反映できます。

本記事では、RustにおけるWeb APIドキュメント自動生成の手順やツールの使い方を具体的に解説します。OpenAPIを活用し、効率よくAPIドキュメントを管理する方法をマスターしましょう。

目次

RustにおけるWeb APIドキュメントの重要性

Web APIを開発する際、ドキュメントはシステム設計と開発者間のコミュニケーションに欠かせない要素です。Rustにおいても、ドキュメントの質がプロジェクトの成功を大きく左右します。以下に、Web APIドキュメントが重要とされる理由を説明します。

1. API利用者への明確な仕様提示


APIドキュメントがあれば、他の開発者やサービスがAPIを利用する際に、どのエンドポイントが存在し、どのパラメータが必要か、返却されるデータは何かを簡単に理解できます。

2. 保守性と拡張性の向上


ドキュメントが整備されていれば、時間が経過してもAPIの仕様が明確なため、新しい開発者やチームメンバーも迅速にシステムを理解し、保守や機能拡張を行いやすくなります。

3. バグや不具合の早期発見


ドキュメントと実際のAPIが常に一致していると、ドキュメント上の誤解や仕様の齟齬によるバグを早期に発見・修正できます。

4. テストと検証の効率化


ドキュメントが正確であれば、APIのユニットテストや統合テストの作成が容易になり、テストの効率も向上します。

5. 自動化ツールとの連携


OpenAPIを使用することで、ドキュメントを自動生成し、Swagger UIなどのツールで視覚的にAPI仕様を確認できるため、開発効率が向上します。

RustでWeb APIを開発するなら、ドキュメントを自動生成し、常に最新の状態に保つことが、効率的でミスの少ない開発を実現する鍵となります。

OpenAPIとは何か

OpenAPIは、Web APIの仕様を記述し、標準化するためのフォーマットです。もともとはSwaggerとして知られていましたが、2015年にLinux Foundationの下でOpenAPI Initiativeとして進化し、現在では広く業界標準として採用されています。

OpenAPIの基本概念


OpenAPIは、APIのエンドポイント、リクエストパラメータ、レスポンスフォーマット、認証方法などを定義するYAMLまたはJSON形式のファイルです。このファイルは、APIの仕様を正確かつ詳細に記述でき、開発者同士の情報共有に役立ちます。

OpenAPIの主な特徴

  • 言語非依存: プログラミング言語に依存せず、どの言語のAPIでも使用可能です。
  • ツールとの連携: Swagger UI、Postman、ReDocなど、さまざまなツールで可視化やテストが可能です。
  • 自動生成: ドキュメント、クライアントSDK、サーバースタブを自動生成する機能を提供します。

OpenAPIのファイル構成例


以下は、シンプルなOpenAPIのYAMLファイル例です。

openapi: 3.0.0
info:
  title: Sample API
  version: 1.0.0
paths:
  /users:
    get:
      summary: ユーザー一覧を取得
      responses:
        '200':
          description: 成功
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string

RustでのOpenAPIの利用


Rustでは、utoipaやpaperclipといったクレートを使用して、OpenAPIドキュメントを自動生成することが可能です。これにより、APIコードとドキュメントの一貫性を保ちながら、効率的に開発が進められます。

OpenAPIを活用することで、APIの仕様を明確化し、開発・保守・テストのすべての段階で品質向上が期待できます。

RustでOpenAPIを利用するための準備

RustでWeb APIドキュメントをOpenAPIを使って自動生成するには、いくつかの前提条件とツールが必要です。以下に、必要なステップとセットアップ方法を解説します。

1. Rustのインストール


Rustがインストールされていない場合は、まずRustをインストールします。以下のコマンドでインストール可能です。

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

インストール後、Rustのバージョンを確認します。

rustc --version

2. 必要なクレートの追加


Cargo.tomlに、OpenAPIドキュメント生成用のクレートを追加します。代表的なクレートとして、以下がよく使われます。

  • utoipa：RustのコードからOpenAPIドキュメントを自動生成するためのクレート。
  • utoipa-swagger-ui：Swagger UIでドキュメントを可視化するためのクレート。
  • serde：JSONシリアライズ/デシリアライズ用のクレート。

Cargo.tomlに以下を追加します。

[dependencies]
utoipa = "3.0"
utoipa-swagger-ui = "3.0"
serde = { version = "1.0", features = ["derive"] }

3. Webフレームワークのセットアップ


Web APIを開発するには、RustのWebフレームワークを使用します。代表的なものには以下があります。

  • actix-web：高パフォーマンスなWebフレームワーク。
  • rocket：簡単に使えるWebフレームワーク。

たとえば、actix-webを使用する場合は、Cargo.tomlに以下を追加します。

actix-web = "4"

4. プロジェクトのディレクトリ構成


基本的なディレクトリ構成の例です。

my_rust_api/
├── Cargo.toml
└── src/
    ├── main.rs
    └── api.rs

5. OpenAPIドキュメント生成のための準備


utoipaを使ってドキュメントを生成するための基本コードを記述します。

use actix_web::{get, App, HttpServer, Responder};
use utoipa::OpenApi;

#[get("/hello")]
async fn hello() -> impl Responder {
    "Hello, world!"
}

#[derive(OpenApi)]
#[openapi(paths(hello))]
struct ApiDoc;

#[actix_web::main]
async fn main() -> std::io::Result<()> {
    println!("{}", ApiDoc::openapi().to_pretty_json().unwrap());
    HttpServer::new(|| App::new().service(hello))
        .bind("127.0.0.1:8080")?
        .run()
        .await
}

これで、RustでOpenAPIドキュメント生成の準備が整いました。次は具体的なドキュメント生成方法について解説します。

utoipaクレートを使ったドキュメント生成

RustでWeb APIドキュメントを自動生成するために、utoipaクレートを利用します。utoipaは、Rustのコードから直接OpenAPIドキュメントを生成するためのシンプルで強力なクレートです。

utoipaの基本設定

まず、Cargo.tomlにutoipaを追加します。

[dependencies]
utoipa = "3.0"
utoipa-swagger-ui = "3.0"  # Swagger UIでドキュメントを表示する場合
actix-web = "4"            # Webフレームワークの例としてactix-webを使用
serde = { version = "1.0", features = ["derive"] }

APIエンドポイントの作成

actix-webを使ってシンプルなAPIエンドポイントを作成します。以下のコードでは、/helloというエンドポイントを定義しています。

use actix_web::{get, App, HttpServer, Responder};

#[get("/hello")]
async fn hello() -> impl Responder {
    "Hello, world!"
}

utoipaによるOpenAPIドキュメントの定義

utoipa::OpenApiマクロを使って、APIドキュメントを生成します。

use utoipa::OpenApi;

#[derive(OpenApi)]
#[openapi(paths(hello))]
struct ApiDoc;

このApiDoc構造体は、/helloエンドポイントに基づいたOpenAPIドキュメントを生成します。

Swagger UIの統合

Swagger UIで生成したドキュメントを可視化するには、utoipa-swagger-uiを利用します。

use actix_web::{web, App, HttpServer};
use utoipa_swagger_ui::SwaggerUi;

#[actix_web::main]
async fn main() -> std::io::Result<()> {
    HttpServer::new(|| {
        App::new()
            .service(hello)
            .service(SwaggerUi::new("/docs").url("/api-doc/openapi.json", ApiDoc::openapi()))
    })
    .bind("127.0.0.1:8080")?
    .run()
    .await
}

このコードにより、以下のURLでSwagger UIが利用できます。

http://127.0.0.1:8080/docs

アプリケーションの起動

以下のコマンドでアプリケーションを起動します。

cargo run

Swagger UIでの確認

ブラウザでhttp://127.0.0.1:8080/docsにアクセスすると、Swagger UIでAPIドキュメントが表示されます。

これで、Rustでutoipaを使ってWeb APIドキュメントを自動生成し、Swagger UIで確認する手順が完了です。ドキュメントはコードと常に同期しているため、仕様変更にも柔軟に対応できます。

rocketフレームワークとOpenAPIの統合

Rustの人気Webフレームワークであるrocketを使用してWeb APIを構築し、OpenAPIドキュメントを生成する方法について解説します。rocketはシンプルで直感的なAPI開発を可能にし、utoipaを組み合わせることで自動的にAPIドキュメントを生成できます。

1. 必要なクレートの追加

まず、Cargo.tomlにrocketとutoipaの依存関係を追加します。

[dependencies]
rocket = { version = "0.5.0-rc.3", features = ["json"] }
utoipa = "3.0"
utoipa-swagger-ui = "3.0"
serde = { version = "1.0", features = ["derive"] }

2. APIエンドポイントの作成

rocketを使ってシンプルなエンドポイントを作成します。以下は/helloというエンドポイントの例です。

use rocket::{get, routes, serde::json::Json};
use serde::Serialize;

#[derive(Serialize)]
struct HelloResponse {
    message: String,
}

#[get("/hello")]
fn hello() -> Json<HelloResponse> {
    Json(HelloResponse {
        message: "Hello, world!".to_string(),
    })
}

3. utoipaを使ったドキュメントの定義

utoipa::OpenApiを使って、OpenAPIドキュメントを生成します。

use utoipa::OpenApi;

#[derive(OpenApi)]
#[openapi(paths(hello))]
struct ApiDoc;

4. Swagger UIの設定

Swagger UIでOpenAPIドキュメントを可視化するためのルートを追加します。

use rocket::{launch, routes};
use utoipa_swagger_ui::SwaggerUi;

#[launch]
fn rocket() -> _ {
    rocket::build()
        .mount("/", routes![hello])
        .mount("/docs", SwaggerUi::new("/docs").url("/api-doc/openapi.json", ApiDoc::openapi()))
}

5. アプリケーションの起動

以下のコマンドでアプリケーションを起動します。

cargo run

6. Swagger UIでの確認

アプリケーションが起動したら、ブラウザで以下のURLにアクセスします。

http://127.0.0.1:8000/docs

Swagger UIが表示され、/helloエンドポイントのドキュメントが確認できます。

コード全体の例

use rocket::{get, launch, routes, serde::json::Json};
use serde::Serialize;
use utoipa::OpenApi;
use utoipa_swagger_ui::SwaggerUi;

#[derive(Serialize)]
struct HelloResponse {
    message: String,
}

#[get("/hello")]
fn hello() -> Json<HelloResponse> {
    Json(HelloResponse {
        message: "Hello, world!".to_string(),
    })
}

#[derive(OpenApi)]
#[openapi(paths(hello))]
struct ApiDoc;

#[launch]
fn rocket() -> _ {
    rocket::build()
        .mount("/", routes![hello])
        .mount("/docs", SwaggerUi::new("/docs").url("/api-doc/openapi.json", ApiDoc::openapi()))
}

これでrocketとutoipaを組み合わせて、Web APIドキュメントを自動生成し、Swagger UIで確認する準備が整いました。これにより、ドキュメントとコードの一貫性を保ちながら効率的にAPI開発が進められます。

actix-webフレームワークとOpenAPIの活用

Rustで高性能なWeb APIを構築するためのフレームワークとして、actix-webが広く利用されています。actix-webとutoipaクレートを組み合わせることで、APIのドキュメントを自動生成し、OpenAPIフォーマットで管理することが可能です。ここではその手順を解説します。

1. 必要なクレートの追加

まず、Cargo.tomlに必要なクレートを追加します。

[dependencies]
actix-web = "4"
utoipa = "3.0"
utoipa-swagger-ui = "3.0"
serde = { version = "1.0", features = ["derive"] }

2. APIエンドポイントの作成

actix-webを使ってシンプルなエンドポイントを作成します。以下は/helloエンドポイントの例です。

use actix_web::{get, App, HttpServer, Responder, HttpResponse};
use serde::Serialize;

#[derive(Serialize)]
struct HelloResponse {
    message: String,
}

#[get("/hello")]
async fn hello() -> impl Responder {
    HttpResponse::Ok().json(HelloResponse {
        message: "Hello, world!".to_string(),
    })
}

3. utoipaを使ったOpenAPIドキュメントの生成

utoipa::OpenApiマクロを使い、エンドポイントの情報をドキュメント化します。

use utoipa::OpenApi;

#[derive(OpenApi)]
#[openapi(paths(hello))]
struct ApiDoc;

4. Swagger UIの設定

Swagger UIを使ってドキュメントを可視化するために、utoipa-swagger-uiを統合します。

use utoipa_swagger_ui::SwaggerUi;
use actix_web::{web, App, HttpServer};

#[actix_web::main]
async fn main() -> std::io::Result<()> {
    HttpServer::new(|| {
        App::new()
            .service(hello)
            .service(SwaggerUi::new("/docs").url("/api-doc/openapi.json", ApiDoc::openapi()))
    })
    .bind("127.0.0.1:8080")?
    .run()
    .await
}

5. アプリケーションの起動

以下のコマンドでアプリケーションを起動します。

cargo run

6. Swagger UIでの確認

アプリケーションが起動したら、ブラウザで以下のURLにアクセスします。

http://127.0.0.1:8080/docs

Swagger UIが表示され、/helloエンドポイントのドキュメントが確認できます。

コード全体の例

use actix_web::{get, App, HttpServer, Responder, HttpResponse};
use serde::Serialize;
use utoipa::OpenApi;
use utoipa_swagger_ui::SwaggerUi;

#[derive(Serialize)]
struct HelloResponse {
    message: String,
}

#[get("/hello")]
async fn hello() -> impl Responder {
    HttpResponse::Ok().json(HelloResponse {
        message: "Hello, world!".to_string(),
    })
}

#[derive(OpenApi)]
#[openapi(paths(hello))]
struct ApiDoc;

#[actix_web::main]
async fn main() -> std::io::Result<()> {
    HttpServer::new(|| {
        App::new()
            .service(hello)
            .service(SwaggerUi::new("/docs").url("/api-doc/openapi.json", ApiDoc::openapi()))
    })
    .bind("127.0.0.1:8080")?
    .run()
    .await
}

まとめ

この手順により、actix-webとutoipaを使ってWeb APIのドキュメントを自動生成し、Swagger UIで可視化する環境が構築できました。これにより、APIの仕様が常に最新状態に保たれ、開発効率と保守性が向上します。

ドキュメントのカスタマイズとバージョン管理

Rustで生成したOpenAPIドキュメントを活用する際、カスタマイズやバージョン管理を適切に行うことで、APIの品質と保守性を向上させることができます。ここでは、utoipaを使ったカスタマイズ方法とバージョン管理のベストプラクティスについて解説します。

1. OpenAPIドキュメントのカスタマイズ

utoipaでは、エンドポイントやパラメータに対して詳細なメタデータを追加することで、ドキュメントをカスタマイズできます。

エンドポイントの説明追加

エンドポイントに説明や要約を追加するには、#[utoipa::path]属性を使用します。

use actix_web::{get, HttpResponse, Responder};
use serde::Serialize;
use utoipa::ToSchema;

#[derive(Serialize, ToSchema)]
struct HelloResponse {
    message: String,
}

/// こんにちはメッセージを取得します
#[utoipa::path(
    get,
    path = "/hello",
    responses(
        (status = 200, description = "成功", body = HelloResponse)
    )
)]
#[get("/hello")]
async fn hello() -> impl Responder {
    HttpResponse::Ok().json(HelloResponse {
        message: "Hello, world!".to_string(),
    })
}

パラメータとリクエストボディの説明

エンドポイントのパラメータやリクエストボディにも詳細な説明を追加できます。

use actix_web::{post, web, HttpResponse, Responder};
use serde::Deserialize;
use utoipa::ToSchema;

#[derive(Deserialize, ToSchema)]
struct GreetRequest {
    name: String,
}

/// 名前を指定して挨拶を返します
#[utoipa::path(
    post,
    path = "/greet",
    request_body = GreetRequest,
    responses(
        (status = 200, description = "挨拶メッセージを返します")
    )
)]
#[post("/greet")]
async fn greet(req: web::Json<GreetRequest>) -> impl Responder {
    HttpResponse::Ok().body(format!("Hello, {}!", req.name))
}

2. ドキュメントのバージョン管理

APIが進化するにつれて、異なるバージョンのドキュメントを管理する必要があります。OpenAPIとutoipaでは、バージョンごとにドキュメントを生成・管理できます。

バージョン情報の追加

OpenAPIドキュメントにバージョン情報を追加します。

use utoipa::OpenApi;

#[derive(OpenApi)]
#[openapi(
    info(title = "My API", version = "1.0"),
    paths(hello, greet)
)]
struct ApiDocV1;

複数バージョンの管理

APIの新バージョンを導入する場合、別の構造体を作成してバージョンを分けます。

#[derive(OpenApi)]
#[openapi(
    info(title = "My API", version = "2.0"),
    paths(greet) // 新バージョンで変更したエンドポイント
)]
struct ApiDocV2;

Swagger UIでバージョンごとのドキュメント表示

異なるバージョンのドキュメントをSwagger UIにマウントします。

use actix_web::{App, HttpServer};
use utoipa_swagger_ui::SwaggerUi;

#[actix_web::main]
async fn main() -> std::io::Result<()> {
    HttpServer::new(|| {
        App::new()
            .service(hello)
            .service(greet)
            .service(SwaggerUi::new("/docs/v1").url("/api-doc/v1/openapi.json", ApiDocV1::openapi()))
            .service(SwaggerUi::new("/docs/v2").url("/api-doc/v2/openapi.json", ApiDocV2::openapi()))
    })
    .bind("127.0.0.1:8080")?
    .run()
    .await
}

3. バージョン管理のベストプラクティス

  • セマンティックバージョニング: メジャー、マイナー、パッチのバージョン形式（例: 1.0.0）を採用する。
  • 非互換変更時のバージョンアップ: 破壊的変更がある場合はメジャーバージョンを更新する。
  • 旧バージョンのサポート: 一定期間は旧バージョンのAPIもサポートし、移行をスムーズに行う。

これで、RustのWeb APIドキュメントをカスタマイズし、バージョンごとに管理する方法が理解できました。ドキュメントの一貫性と柔軟性を保つことで、APIの信頼性が向上します。

デプロイ時にドキュメントを自動更新する方法

RustのWeb APIを本番環境にデプロイする際、OpenAPIドキュメントを常に最新の状態に保つことは重要です。手動でドキュメントを更新する手間を省くために、自動でドキュメントを更新・デプロイする方法について解説します。

1. OpenAPIドキュメントをビルド時に生成する

アプリケーションのビルド時にOpenAPIドキュメントを自動生成するように設定します。以下はbuild.rsを利用した例です。

Cargo.tomlにutoipaとserdeを追加:

[dependencies]
utoipa = "3.0"
serde = { version = "1.0", features = ["derive"] }

[build-dependencies]

utoipa = “3.0”

build.rsファイルの作成:

プロジェクトのルートにbuild.rsを作成し、ドキュメントを生成する処理を記述します。

use std::{env, fs, path::Path};
use utoipa::OpenApi;
use my_rust_api::ApiDoc; // APIドキュメント定義

fn main() {
    let out_dir = env::var("OUT_DIR").unwrap();
    let dest_path = Path::new(&out_dir).join("openapi.json");
    let openapi = ApiDoc::openapi().to_pretty_json().unwrap();

    fs::write(dest_path, openapi).expect("Failed to write OpenAPI JSON");
}

src/lib.rsにAPIドキュメント定義を追加:

use utoipa::OpenApi;
use crate::handlers::hello;

#[derive(OpenApi)]
#[openapi(paths(hello))]
pub struct ApiDoc;

2. ドキュメントを静的ファイルとして提供

ビルド時に生成したopenapi.jsonを静的ファイルとして提供します。

use actix_files::Files;
use actix_web::{App, HttpServer};

#[actix_web::main]
async fn main() -> std::io::Result<()> {
    HttpServer::new(|| {
        App::new()
            .service(Files::new("/api-doc", "target/debug/build/my_rust_api-xxxxxxx/out"))
    })
    .bind("127.0.0.1:8080")?
    .run()
    .await
}

3. CI/CDパイプラインで自動化

CI/CDパイプラインを使って、デプロイ時にドキュメントを自動的に生成し、本番環境に反映します。以下はGitHub Actionsを使った例です。

.github/workflows/deploy.yml

name: Deploy Rust API

on:
  push:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - name: チェックアウト
        uses: actions/checkout@v3

      - name: Rustのセットアップ
        uses: actions-rs/toolchain@v1
        with:
          toolchain: stable
          override: true

      - name: 依存関係のインストール
        run: cargo build --release

      - name: OpenAPIドキュメント生成
        run: cargo run --release

      - name: デプロイ
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./target/release

4. デプロイ後のドキュメント確認

デプロイが完了したら、本番URLでOpenAPIドキュメントが反映されているか確認します。

https://your-domain.com/api-doc/openapi.json

Swagger UIが統合されていれば、以下のようなURLでドキュメントを確認できます。

https://your-domain.com/docs

まとめ

  • ビルド時にドキュメントを自動生成し、常に最新の状態に保つ。
  • CI/CDパイプラインを活用して、デプロイ時に自動でドキュメントを反映。
  • 本番環境でドキュメントを提供し、APIの仕様をいつでも確認可能にする。

これにより、APIドキュメントとコードの一貫性を維持し、効率的に開発・運用が行えます。

まとめ

本記事では、RustでWeb APIドキュメントをOpenAPIを使って自動生成する方法について解説しました。utoipaクレートを活用し、actix-webやrocketフレームワークと組み合わせることで、コードとドキュメントを常に同期させ、効率的に管理する手法を紹介しました。

また、ドキュメントのカスタマイズ方法やバージョン管理、デプロイ時に自動でドキュメントを更新する方法についても触れました。これにより、APIの仕様が常に最新の状態に保たれ、チームやユーザーとのコミュニケーションがスムーズになります。

Rustの強力な型安全性と高パフォーマンスを活かしながら、OpenAPIを導入することで、Web API開発の品質と保守性を大幅に向上させることができます。

Rust
Web API OpenAPI ドキュメント生成 Rust

コメント

コメントする

目次