メインコンテンツへスキップ
見出し画像

FastAPI がどれだけ親切だったか、気づいた話

    Cloudflare Workers AI を使ってみたくって、それまで python FastAPI で動作させていた API を TypeScript に移植してみた。ちなみに TypeScript newbie である。

    Python FastAPI

    作る手順はこんな感じ

    1. pydantic でせっせとschema定義を書く

    2. endpoint method で In と Out の schema を定義する

    3. app annotationを追加する

    終わり。入力と出力の validation はこれで終わり。
    localhost:[好きなport番号]/docs で OpenAPI UI がレンダリングされるので API 動作をOpenAPI UI から確認できる。ちょろっと試すには大変便利。

    TypeScript

    Hono + Zod

    TypeScript 初心者なので、よくわからない。しかし、どの言語にも類似機能があるものだ。調査したところ、schema validation を実施したい場合には、Hono + Zod を使うらしい。自分で routing 定義を記述する必要があるようだ。
    ref: https://hono.dev/examples/zod-openapi

    1. schema 定義を zod 書く

    2. routing 定義を Hono で書く zod で記述した定義を使う

    3. OpenAPI 用定義と routing を Hono で書く

    サンプルコード

    FastAPI でラクさせてもらっていたんだなと思う。記述の流れは同じだが、記述量が違う。Hono zod-OpenAPIサンプルのコードが以下。

    import { createRoute } from '@hono/zod-openapi'
    
    const healthCheckRoute = createRoute({
      method: 'get',
      path: '/',
      responses: {
        200: {
          description: 'Health check and version info',
          content: {
            'application/json': {
              schema: z.object({
                status: z.string(),
                version: z.string(),
                environment: z.string().optional(),
              }),
            },
          },
        },
      },
    });
      
    app.openapi(healthCheckRoute, (c: any) => {
      const versionInfo = getVersionInfo(c.env.ENVIRONMENT);
      return c.json(versionInfo);
    });

    python + FastAPI サンプルは以下。

    from fastapi import FastAPI
    from pydantic import BaseModel
    from typing import Optional
    
    app = FastAPI()
    
    class HealthCheckResponse(BaseModel):
        status: str
        version: str
        environment: Optional[str] = None
    
    @app.get(
        "/",
        response_model=HealthCheckResponse,
        summary="Health check and version info",
    )
    def health_check():
        version_info = get_version_info()
        return version_info

    python + FastAPI は endpoint ロジックを記述することだけに集中できる。Media type をわざわざ書く必要もない。
    それと、個人の感想だけれど、TypeScript の閉じカッコが続く感じが、少しつらい。

    FastAPI が親切すぎるのかもしれない

    FastAPI では

    • ルーティング

    • 型定義

    • 実行時バリデーション

    • OpenAPI 定義

    これらが一体化している。

    Hono + Zod では

    • ルーティング

    • 型(TypeScript)

    • 実行時バリデーション(Zod)

    • OpenAPI 定義

    これらを、意識的に「つなぐ」必要がある。地図だけ渡されて、自分で道をつなぐのだ。その分、どこで何が起きているかは明確だが、記述負担が大きい。けれど、初心者こそ、TypeScript で書いてみるべきかもしれない。何が、どうなって動いているか、学びやすいと思う。

    感想

    「サクっと書いて試す」「統計ライブラリを使いたい」
    そういうときに python を選ぶことが多かった。

    だからといって、python が好きで TypeScript が嫌い、という話ではない。言語は、必要に応じて使えばいいと思っている。

    ちなみに Ruby は、今のところ好きになれない。自分は、軽くて簡潔なものが好きなのだ。


     
     

    asako

     
     
    深く考えず、noteアカウントを作りました。何を書いていくのか、決めていません。無職です。仕事探しています。

    あなたへのおすすめ