Devsway

日々の記録とか記憶とか。


用語


OASとは?


OpenAPI Speficificationの略。

Speficificationは仕様の意味。

これだけだといまいちピンとこないかもしれません。

実際の定義の書き方は見るとすぐわかります。

SwaggerではこんなかんじでYamlで定義できます。

そのプロパティ名とかのお約束がOpenAPI Speficificationだと思えばわかりやすいですね。


paths:
  /users:
    get:
      description: ディスクリプション内容!
      parameters:
       - $ref: '#/aaa/bbbb/ccc'

始め方


APIを最初から作る場合


①Swagger EditorでAPIの定義を記述

②Swagger Codegenでサーバーサイドの実装をジェネレイトする。

③Swagger UIを使って見やすいドキュメント化する

④Swagger Hubを使ってチームとして共有する


既存のAPIからAPI定義を作成する場合


できないことはないですが、少し面倒なことをしないといけないぽいですね。

さすがに全自動とはいかないみたいです。



個人的メモ


SwaggerHubはGithubみたいにSwagger定義を保存・管理しておく場所。

クラウド上で管理することでチーム管理ができる。(素敵)

SwaggerUIもSwaggerHub上にホストする。


このページはあくまでもDEMOです。


https://editor.swagger.io/?_ga=2.216139798.1641354083.1570358907-1497048991.1569947874


実際にはSwaggerEditorで書いたやつをSwaggerHub上にインテグレートします。


参考


https://swagger.io/tools/open-source/getting-started/




カテゴリー

オレオレIT用語辞典