5月 2020年

今回は「OpenAPI Specification の使い方」についてまとめます。 OpenAPIに触れるとでてくる Swagger についても、位置づけや役割もあわせてまとめています。 目次 概要 OpenAPI とは Swagger とは データ型 基本構造 スキーマ詳細 info servers tags paths パス、メソッド、操作 リクエストパラメーター リクエストボディー ...

今回は「Swagger Codegen の使い方」についてまとめます。 インストールからソースコード生成、動作確認までの一連操作を自PC上で行う場合の手順をまとめています。 目次 Swagger Codegen とは インストール コード生成 生成したサーバーサイドコードの動作確認 Swagger Codegen とは Swagger Codegen とは「OpenAPI Specificatioinに従って記述されたAPI仕様書を元に、ソースコードを生成するツール」です。 Swagger Editor, UI とともによく使われるツールになります。 Web上で出力もできますし、Dockerを利用した出力方法もありますが…今回は純粋に自端末で出力する方法をまとめます ...

今回は「Swagger UI の使い方」についてまとめます。 目次 Swagger UI とは 基本的な使い方 Node.js + Express サーバー上に展開 サーバーの実装 サーバーの起動 動作確認 初期表示のカスタマイズ 自身のAPI仕様を表示 ヘッダーを非表示 （おまけ）最終的な構成 Swagger UI とは Swagger UI とは「OpenAPI Specificatioinに従って記述されたAPI仕様書をWebページ上で見やすく表示するツール ...