LoginSignup
3

More than 5 years have passed since last update.

SwaggerのSpecのYAMLファイルをHTMLに変換する

Last updated at Posted at 2018-08-24

screenshot-1.png

変換

docker run -i yousan/swagger-yaml-to-html < petstore.yaml > petstore.html

経緯など

SwaggerHubで作成されるHTMLがいい感じだったんですが、ウェブでファイルを管理するのが大変だなと思っていて、Gitでyamlファイルを管理しつつ、HTMLに生成できないかなと思っていました。

調べてもなかなか情報が出てこなかったんですが、Pythonのスクリプトを発見しました。

原理としてはすごく単純で、SwaggerHubのHTML+JavaScriptを読ませていて、YAMLの実体をJSONに変換して読み込ませています。

これがPython環境だったので簡単なものですがDocker化してみました。

あとはこれでYAMLを管理しているGitで変換かけるスクリプトを置くと良いです。

というか結構あった

それなりにググってたつもりだったんだけど、「swagger yaml html」だと結構あった…。
https://qiita.com/nmatsui/items/ed9ae462141eeadb6f6a
https://qiita.com/mokkos/items/3dc977b8b231adbbedf7
https://iktakahiro.hatenablog.com/entry/2016/11/23/100000

オンラインでやりたい

というかこういう簡単な変換系でもPythonとかNodeが必要なものって結構あるじゃないですか。そういうのをオンラインでURLベースで変換できるサービス群作りたいですね。

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
3