LoginSignup
0
0

More than 1 year has passed since last update.

バックエンドとフロントエンドでREST APIスキーマを簡単に共有する。【OpenAPI】

Last updated at Posted at 2021-06-08

かなり今更感が強いですがOpenAPIについて薄い記事を書きます。

OpenAPIはRest APIのスキーマを定義する規格ですが、それをもとに自動でAPIのドキュメントを生成したり
API ClientのSDKを自動生成することができます。(APIリクエストするコードを描く必要はありません。)

REST APIのスキーマを開発前から定義しておくことでバックエンドの開発を待たずに
フロントエンドの開発を進めることも可能です。
フロントエンドのAPI Client SDKはAxios、Fetch、Redux-queryなどメジャーなものはほぼサポートされています。

また、バックエンド側でStubを利用してOpenAPIのスキーマを自動生成することも可能です。
サーバー側のStubが利用可能なフレームワークは以下の通りです。

自動生成されたAPIのドキュメント(Swagger)
image.png

公式Ebookたち
https://drive.google.com/drive/folders/1noArns8WacpJM7TG5ojkiii6BLMWNqVN

公式Github
https://github.com/OpenAPITools/openapi-generator#overview

よさげなQiita
https://qiita.com/amuyikam/items/e8a45daae59c68be0fc8#openapi

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0