やっほー
超簡単やで!SwaggerにSQLを記述する方法!

超簡単やで!SwaggerにSQLを記述する方法!

SwaggerにSQLを記述したいと思ったのですが、そんなことをしている人はおらず。。

しかも、情報は全くなし。

ということで今回は、SwaggerにSQLを記述する方法をご説明します!

Swaggerとは

Swaggerは、ざっくり言うと「APIの設計書」です。

詳細はここでは割愛します。

なぜSwaggerにSQLを?

SwaggerをAPI設計書として作成していたのですが、「じゃあSQLはどうする?」となり、Swaggerに記述することになりました。

「SQLを別のところに書くと設計書が多くなるのでSwaggerに書いた」という経緯があります。

SwaggerにSQLを記述するメリット

  • 設計書を一つにまとめることができる

SwaggerにSQLを記述するデメリット

  • Swaggerはyamlファイル(もしくはjsonファイル)だが、そもそもyamlファイルにSQLは書かない
  • 結構強引に書かざるを得ない

SwaggerにSQLを記述する方法

yamlファイルは説明文(description)を記述できるので、そこにずらずらとSQLを書いていきます。

以下は、AWSのAPI Getewayにデフォルトで登録されている「PetStore」のSwaggerになります。

Swaggerの「description」内ではHTMLタグが有効になるので、SQLをpreタグで囲みます。

preタグで囲むと以下のように、いい感じに表示されます。

SwaggerにSQLを記述

まとめ

SwaggerにSQLを記載してみましたが、そもそもyamlファイルにSQLを記述するのはよろしくないですね。。

情報が全然出てこないということは皆やらないということだと思いますが、僕は何でもやってみよう精神で生きております。。

この記事が誰かの役に立てば幸いです。

超簡単やで!SwaggerにSQLを記述する方法!
フォローしてもらえると泣いて喜びます