API仕様をOpenAPIで公開する

[watanavex]

• [ ] バグ / Bug
• [*] 改善提案 / Suggestions for improvement

期待する見せ方・挙動 / Expected behavior

案として、

• Swagger-UIでAPI仕様を公開する
• github pagesでホスティングする

[watanavex]

covid19hokkaido_scraping のgh-pagesはもう使ってしまっているので、 codeforsappor でホスティングするか... 新規にリポジトリ作っちゃった方がいいかな🙄

[watanavex]

Swagger-UIじゃなくてこの辺でもいいかも https://redocly.github.io/redoc

[takayuki-fuwa]

試しにこんな感じでswaggerに起こしてみましたけど、いかがでしょう？ https://github.com/yuesan/covid19hokkaido_webapi/blob/master/swagger.yaml

[watanavex]

@yuesan いい感じだと思います！ありがとうございます！

[watanavex]

@Kanahiro covid19hokkaido_scraping ここに index.htmlとリファレンスになるyamlを置いて一緒に公開するのってどう思います？ ごちゃつくので避けた方がいいですかね？

[watanavex]

これでAPI公開する場合、htmlファイル1個とyamlだけでいけちゃいます。 https://redocly.github.io/redoc

[Kanahiro]

gh-pagesでホスティングしたら見やすいのかなと思うので、別リポジトリでgh-pagesを使うのがよいと思います。なんならc4s.io使っちゃうとかはどうなんですかね。

[Kanahiro]

ただSwaggerというものに詳しくないため、お任せになってしまうかなと…🤔

[watanavex]

@Kanahiro ありがとうございます！ では一旦、別リポジトリ作ってやってみます！

[watanavex]

@yuesan codeforsapporoにforkしました！

[takayuki-fuwa]

https://github.com/codeforsapporo/covid19hokkaido_scraping/tree/gh-pages にあったJSONファイルを基に、一通りOpenAPI定義に起こしてみました。 また、yamlファイル名をswagger.yamlとしていたのですが、swagger-uiに限らず使えるので、webapi.yamlとリネームしました。

https://github.com/yuesan/covid19hokkaido_webapi/blob/master/webapi.yaml

[watanavex]

https://codeforsapporo.github.io/covid19hokkaido_webapi/ 暫定で公開済み。

詳細は別issueで修正していく。