vercel[bot]
commented
1 year ago The latest updates on your projects. Learn more about Vercel for Git ↗︎
| Name | Status | Preview | Comments | Updated (UTC) |
|---|---|---|---|---|
| timelogger-web | ✅ Ready (Inspect) | Visit Preview | 💬 Add feedback | Apr 19, 2023 2:51pm |
HAYASHI-Masayuki
issueURL
https://github.com/commew/timelogger-web/issues/63
この PR で対応する範囲 / この PR で対応しない範囲
https://github.com/commew/timelogger-web/issues/63 の完了の定義にあるようにコミット毎にOpenAPIのドキュメントがHTML形式で閲覧出来るようになっている事。
Storybook の URL、 スクリーンショット
なし
変更点概要
やった事の概要
https://docs.stoplight.io/docs/elements/a71d7fcfefcd6-elements-in-html の公式ドキュメントを参考にVercel上でHTML形式のドキュメントを閲覧出来るようにしました。
↓は公式のデモです↓ https://elements-demo.stoplight.io
今後は
/docs/apiにアクセスを行う事でいつでもHTML形式のドキュメントを閲覧可能になりました。Vercelはコミット毎にプレビュー環境のURLを生成するのでコミット毎のドキュメントを確認する事も可能です。
以下のURLは本PRの最新コミットに紐付いているAPI ドキュメントになります。
https://timelogger-web-git-feature-issue63add-openapi-html-docs-commew.vercel.app/docs/api
具体的な変更点
Vercelの仕組み上、静的なHTMLを公開する為にはpublicディレクトリにHTMLファイルを配置する必要があります。
その為、https://github.com/commew/timelogger-web/pull/58 で作成した
openapi.yamlの位置を/public/docs/api/openapi.yamlに移動させてあります。レビュアーに重点的にチェックして欲しい点
@stkzk3110 @c501306014
APIドキュメントのデプロイ方法に関して他に意見があればお願いします。
他にもS3等に配置したり
https://stoplight.ioにGitHubを連携させてデプロイする方法がありますが、このPRで行った方法が最も工数がかからない手軽な方法になります。@HAYASHI-Masayuki @HaruyaFujimoto
APIドキュメントの閲覧方法だけ確認をお願いします。
このPRがマージされてからは以下のURLで常に最新のAPIドキュメントが閲覧出来るようになります。
https://timmew.commew.net/docs/api
補足情報
インラインコメントに記載。