#技術書典9でOpenAPI 3の完全解説本を更新します
9/12から始まるる技術書典9で「OpenAPI 3を完全に理解できる本 3.0.3対応版」を頒布します。
OpenAPI3に関するおそらく唯一の日本語完全解説本です。 この本ではOpenAPI 3の説明や、実際にどういう風に定義を書いていくかについての説明、および簡単な応用例などを載せています。
こちらは、「技術書典7でOpenAPI 3の完全解説本を出しました」で頒布したものをアップデートし、現在の最新である3.0.3に対応させたものです。
差分はそれほど大きくないため、既に持っている方向けには電子版を最新版に差し替えています。
再度DLしていただくと最新のものに差し替わります。
また、物理本を少量ですが用意しました。
他にも kubectl完全逆引きリファレンスと Microservices architecture よろず本 その三は物理本を若干数用意しています。 Microservices architecture よろず本 その一&その二も頒布しています。
OpenAPI 3を完全に理解できる本の目次
内容は以下になります
第1章 OpenAPI とはなにか
1.1 OpenAPIの概要
1.2 OpenAPIの歴史
第2章 OpenAPI 3 の簡単な説明
2.1 基本構造
2.2 様々なパスの表現
2.3 同じ要素を一箇所にまとめる
2.4 パラメータを利用する
第3章 OpenAPI 3 仕様解説
3.1 基本的な要素の仕様
3.1.1 MUST SHOULDなどの表現
3.1.2 Path Templating
3.1.3 Media TypesとMedia Type Range
3.1.4 HTTPステータスコード
3.2 OpenAPI3の基本仕様
3.2.1 バージョン
3.2.2 フォーマット
3.2.3 ドキュメント構造と参照($ref)
3.2.4 URLの相対パス表現
3.2.5 データタイプ
3.2.6 Rich Text Formatting
3.3 各種Object解説
3.3.1 OpenAPI Object
3.3.2 Info Object
3.3.3 Contact Object
3.3.4 License Object
3.3.5 Server Object
3.3.6 Server Variable Object
3.3.7 Components Object
3.3.8 Paths Object
3.3.9 Path Item Object
3.3.10 Operation Object
3.3.11 External Documentation Object
3.3.12 Parameter Object
3.3.13 Request Body Object
3.3.14 Media Type Object
3.3.15 Encoding Object
3.3.16 Responses Object
3.3.17 Response Object
3.3.18 Callback Object
3.3.19 Example Object
3.3.20 Link Object
3.3.21 Header Object
3.3.22 Tag Object
3.3.23 Reference Object
3.3.24 SecurityScheme Object
3.3.25 OAuthFlows Object
3.3.26 OAuthFlow Object
3.3.27 Security Requirement Object
3.4 Runtime Expressions
3.5 Specification Extensions
3.6 Security Filtering
第4章 Schema Object と関連するオブジェクト
4.0.1 Schema Objectの基本フィールド
4.0.2 OpenAPI 3で仕様変更したフィールド
4.0.3 OpenAPI 3で拡張したフィールド
4.0.4 合成とPolymorphism
4.0.5 Discriminator Object
4.0.6 XMLObject
第5章 定義ファイルの利用方法
5.1 SwaggerUIを使ってAPIドキュメントにする
5.2 OpenAPI Generator を使ってクライアントライブラリを生成する
5.3 committeeを使ってバリデーションを行う
5.4 まとめ