サイトアクセス数: 2,498

OpenAPI運用 | SE WIKI

Wiki

Backend

Express設計 OpenAPI運用

Clean Architecture

Controllerの責務 Domain Entityの責務 Gatewayの責務 UseCaseの責務

Sample

コード埋め込みサンプル

Backend/docs/backend/01-openapi.md

OpenAPI運用

このバックエンドでは、OpenAPIをHTTP契約の正として扱います。

backend openapi validation GitHubで開く

OpenAPI運用

このバックエンドでは、OpenAPIをHTTP契約の正として扱います。

分割した定義を openapi/src/ に置き、bundleした openapi/openapi.yaml をExpressのOpenAPI validatorが読み込みます。

方針

routeの入力検証はOpenAPIで行う
Controllerは検証済みの値をUseCaseへ渡す
API追加時はOpenAPI定義も一緒に更新する

目次