Skip to content
Tag

Openapi

Articles and publications tagged Openapi across the Atmosphere.

9articles6publications
ばうあーろぐ
ばうあーろぐ
Mar 17, 2019
OpenAPI (Swagger) の基本的なあれこれ
現時点での OpenAPI に関する知識の棚卸しをした方がいいかなと思ったので書きます。 前提 使い方が 100% 定まっているわけではありません 少なくとも OpenAPI を使っていくこと自体は間違ってないという考えで使っています GraphQL については触れません OpenAPI とは何か? 端的に言うと、 RESTful API に関するインターフェース定義 です。 一方で、そのインターフェース定義は YAML ファイルもしくは JSON ファイルで表されるため、 単なる YAML (JSON) ファイル だということもできると思います。 その仕様に沿って書くことで、周辺ツールであれこれ便利なことができます。 こんな便利なことができる 定義ファイルを元にドキュメントが自動生成できる(むしろ定義ファイル自体がドキュメントとも言える) スタブ API の生成ができる、ダミーの API が定義ファイルから作れる 周辺ツールとして、 Swagger Editor (定義ファイルの編集)や Swagger UI (API のドキュメントやテスト)がある などなど・・・。 OpenAPI は Swagger 3.0 Swagger 3.0 から OpenAPI に名前が変わったため、 OpenAPI 3.0 は Swagger 3.0 でもあります。 もともと他にも API 周りのインターフェース定義ができるルールが存在してたのですが、 Swagger が晴れて標準となったようです。 他には API Blueprint などがあるようですが、僕もそこまで詳しくはありません。
APIOpenAPI

You've reached the end.