express-openapiを試してみた

はじめに エンジニアの籏野です。 フォルシアではOpenAPIでAPI定義を書いてから、APIを実装するのが一般的になってきました。 APIの実装についてはTypeScriptとexpressを利用することが増えてきている状況です。 今回はexpressとOpenAPIをより強固に結びつけるためのモジュールとしてexpress-openapiを見つけたので試してみました。 ざっくりまとめ エンドポイントをOpenAPI定義に沿って作成してくれる リクエストパラメータのバリデーションもお手の物 レスポンス項目もチェックしてくれる 成果物 環境 Node.js: 16.13.2 TypeScript: 4.6.2 express: 4.17.3 express-openapi: 10.1.0 準備 npmでプロジェクトを作成し以下のモジュールをインストールします。 linter等はお好みで。

[yyamano]

“initialize({ app: app, apiDoc: path.resolve(__dirname, "openapi.json"), validateApiDoc: true, operations: { getUser: [ function (req: Request, res: Response, next: NextFunction) { next();”