ProWebAPI

このドキュメントでは、ProWebAPI を使用した堅牢で標準化された ASP.NET Core API の実装について詳しく説明します。 Swagger の統合、依存関係の挿入、標準化された応答、バージョン管理、要求の検証、OData v4 サポート、グローバル例外処理、UnitOfWork を使用した EF Core などの重要な側面をカバーしています。このガイドには、各コンポーネントの段階的な手順が記載されています。

プロウェブAPI

すべての適切な標準を備えた ASP.NET Core API

実装されている標準

闊歩する

Swagger をインストールする

セットアップDI

APIの標準レスポンス

標準応答

バージョン管理

Nuget ライブラリをインストールする

依存関係コンテナに追加

必要に応じてコントローラーを装飾します

リクエストバリデータ

Nuget ライブラリをインストールする

DIにバリデータを登録する

「RequestDto」名前空間に、dto とともにバリデーターを追加します。

ValidationFilter を構築する

フィルターを登録し、[ApiController] auto 400 Bad Request インターセプトをオフにします

AppSettings.json

データベースのアプリ設定を構成する

2 つの ENVIRONMENT 構成を作成する

OData v4

OData をサポートするには NuGet パッケージをインストールします

OData のサービス DI に追加

OData の構成

[EnableQuery] 属性を [EnableOData] でオーバーライドしてエラーをキャッチし、標準応答を返す

アクションメソッドを装飾する

URLによるクエリ

グローバル例外ハンドラー

ミドルウェアを作成する

アプリビルダーの拡張メソッドを作成する

ミドルウェアを登録する

応答のケーシング

OData クエリの結果が大文字小文字と競合しないように、メンバーの大文字小文字を許可します (小道具の場合はパスカル大文字になります)。

EFコア + 作業単位

サポートするクラス ライブラリを追加する

ProWeb.Data に必要なパッケージをインストールします。

移行を実行するには

ProWeb.Data を [スタートアップ プロジェクト] として設定し、移行を実行します