はじめに
下記の状況のなか、ASP.NET Web APIを初めて学ぶことになった（仕事の都合）。情報量が少なく、情報収取で苦労したため、資料として残す。
- ASP.NET Coreがスタンダードで、ASP.NET Web APIは今から学ぶ価値があまりない。下記のような記事が存在するほど。
Asp.Net Web Api is dead, long live Asp.Net Core - ASP.NET Web APIの情報量は、ASP.NET Coreに比べると情報が少ない。
- Microsoftのドキュメントも、メンテナンスが不十分でリンクが所々使えない。
役立ったサイト
| No | 名称 | 概要 | 備考 |
|---|---|---|---|
| 1 | Web API のガイダンス | Microsoft社の公式ドキュメント。 | 必要な情報は概ね揃っている。 所々記事のリンクが使えなくなっているのが、問題点。 |
| 2 | ASP.NET WEB API2:HTTP MESSAGE LIFECYLE | Microsoft社のポスター。 | フレームワーク内でHTTPメッセージをどのようにハンドリングしているか解説したポスター。 初めに読むとフレームワークの処理の流れを大雑把につかめる。 |
| 3 | 連載：ASP.NET Web API 入門 | @ITのASP.NET Web APIの紹介記事。 | 一番はじめの取っ掛かりには有用だった。 Microsoft社の公式ガイダンスをかじった後だと物足りない。 |
役に立った書籍
| No | 書籍名 | 備考 |
|---|---|---|
| 1 | ASP.NET Web API 2 Recipes: A Problem-Solution Approach (Recipes Apress) | 問題点と解決するためのコードサンプルがセットになった本。 サンプルコード |
知見者のサイト
| No | 名称 | 概要 | 備考 |
|---|---|---|---|
| 1 | miso_soup3さんBlog | miso_soup3さんの個人ブログ | 知りたい情報が明確化になっていて、公式以外の情報を知りたい場面なら役立ちそう。 |
| 2 | TonyTonyKunさんBlog | TonyTonyKunさんの個人ブログ | 実装が参考になった。multipart形式の画像アップロードなど情報が少ないものを解説しているのも助かる。 |
コードサンプル
| No | 名称 | 概要 | 備考 |
|---|---|---|---|
| 1 | MSDN Code Gallery Microsoft Samples | MSDNのソースコードの公開されている。 | ただし、Githubからソースサンプルをzipでダウンロードしても開けない。 ファイル欠損しているか、容量が大きすぎるためと思われる。 |
| 2 | Git:SampleCode | Microsoft ASP.NETのリポジトリ | サンプルコードが多数ある。 |
トピック
モデル検証
| No | 参考資料 | 説明 |
|---|---|---|
| 1 | ASP.NET Web API でのモデル検証 | Microsoft公式ページ。 |
| 2 | Creating Your Own Validation Attribute In MVC And Web API 2.0 | C# Cornerの記事。 検証の属性に関する記事。 |
| 3 | Web API Validation | C# Cornerの記事。 カスタム検証属性の実装方法が2つ紹介されている。 1. IValidatableObjectを使用した方法 2. OSS Fluent Validationを使用する方法 |
Swaggerの適用方法
| No | 参考資料 | 説明 |
|---|---|---|
| 1 | 【連載】ASP.NET Web API を使おう：第2回 Swaggerを適用する | Microsoft MVP 中村さんの書いた記事。 2018-02-13 |
| 2 | Swagger を使った ASP.NET Web API のドキュメント生成 | miso_soupさんが書いた記事。 swagger適用に関する仕組みが分かりやすく解説されている。 2014-12-17 |
| 3 | Swashbuckle Swagger Integration In WebApi 2 | 米国のC#コミュニティ C## Cornerに掲載されていた記事。 |
| 4 | Swagger公式ページ | OpenAPI仕様の公式ページ。 Gitのページ |
| 5 | Git :Swaggerパッケージ | Swaggerのパッケージ Swashbuckleのページリンク |
multipart/form-dataをWeb APIに組み込む
| No | 参考資料 | 説明 |
|---|---|---|
| 1 | ASP.NET Web API で multipart / form-data を使ってファイルをアップロードする | multipart / form-dataを用いて、クライアントからサーバに画像をアップロードする実装が記載されている。 |
JSON.NET(Newtonsoft.Json)
| No | リンク | 備考 |
|---|---|---|
| 1 | 公式ドキュメント | |
| 2 | JSONデータを作成／解析するには？ | わかりやすい記事 |
| 3 | C# の Json.NET を理解する | Qiitaの解説記事 |