Open Msksgm opened 1 year ago
Msksgm
commented
1 year ago 以下の README を参照。
https://github.com/Msksgm/swagger-ui
完成すると、以下のように swagger-ui を生成できる。
https://msksgm.github.io/swagger-ui/
Settings から github pages を設定する。
sunakan
commented
1 year ago Redocを推しますがどうでしょう？
https://redocly.github.io/redoc/#tag/pet_model
OpenAPI + ReDocでSchema定義を自動でドキュメント化する
あー、これみるとSchema定義のドキュメンテーションではちょっとイジる必要がありそうですね（見やすくて魅力的なんですが）
ReDocがそもそも複数のYAMLに対応していないので、このopenapi-redoc-schema-defも複数のYAMLには対応していません。その場合は、分散したYAMLをひとつのYAMLにまとめてから、openapi-redoc-schema-defを利用する必要があります。
↑もあるので、Redocは一旦見送るでいいかもです
概要
swagger-ui を作成して、以降 api 仕様書を確認するときにブラウザから確認できるようにする。
方針
sunabak0 に swagegr-ui のリポジトリを作成する。 swagger-ui の github pages を作成して、query パラメータから openapi.yaml を指定するようにする。
Docker を使った方が、アップデート周りで保守性が高いが、デプロイやドメイン周りで管理コストがかかる。 github pages だったら管理する必要がないので楽そう。