swaggerについて

swaggerについて

swaggerとは
Swaggerは、APIを設計、視覚化、文書化するための一連のツールを指す総称
Swaggerツールは、API仕様を視覚化し、動作確認を容易にするほか、APIドキュメントの生成によってチーム内の共有や開発効率の向上を支援する

openapiとは

OpenAPIは、RESTful APIを定義するための業界標準の仕様
この仕様に基づき、APIの構造、パラメータ、レスポンスなどをJSONやYAML形式で記述する
OpenAPIに基づいたAPI仕様を作成するための支援ツールとして、Swagger EditorやSwagger UIなどが使用される

swaggerツールのコンポーネント

Swagger Editor：OpenAPI仕様に基づいたAPIを設計するためのエディタ
Swagger UI：OpenAPI仕様に基づいたAPIを視覚的に確認し、APIリクエストのテストを行うためのツール
Swagger Codegen：OpenAPI仕様からコードを自動生成するためのツール

Swagger エディタとは何ですか?

OpenAPIの動作確認方法

１．Swagger UIのセットアップ手順は以下
setup手順

２．開発サーバーを起動する

npm run dev

３．以下メッセージを確認できれば起動できている

<i> [webpack-dev-server] Loopback: http://localhost:3200/
webpack 5.94.0 compiled successfully in 96554 ms

４．ブラウザにてSwagger UIが表示されることを確認する

５．/pet/findByStatusエンドポイントに対してHTTPリクエストを送信する

curl -X 'GET' \
  'https://petstore.swagger.io/v2/pet/findByStatus?status=available' \
  -H 'accept: application/json'

出力内容は以下

[
	{
		"id": 9223372036854775000,
		"name": "doggie",
		"photoUrls": [],
		"tags": [],
		"status": "available"
	},
	{
		"id": 9223372036854775000,
		"category": {
			"id": 0,
			"name": "string"
		},
		"name": "doggie",
		"photoUrls": [
			"string"
		],
		"tags": [
			{
				"id": 0,
				"name": "string"
			}
		],
		"status": "available"
	},

感想

次はもうひと手間加えたいです