search

opthub-org / opthub-api-client

https://opthub-api-client.vercel.app
MIT License
0 stars 0 forks source link

Swagger UIのセットアップ #3

Closed Mishima-Ryuji closed 2 weeks ago

Mishima-Ryuji commented 3 weeks ago

ユーザにREST API経由でもアクセスできることを促すため、Swagger UIによるREST APIの仕様書の表示ができると望ましいです。このリポジトリでセットアップして、静的ファイルとしてHTMLで開けるようにした上で、VercelやGitHub Pagesに置こうかなと思ってます。Swagger UIを開くための静的ファイルをローカルで作るところまでお願いします。

lanexpr commented 3 weeks ago

Swagger UIの静的ファイルを生成するスクリプトを作成し、ローカルで表示を確認しました。 生成物はui/swagger-ui-5.17.14/distに配置されます: https://github.com/opthub-org/opthub-api-client/tree/main/ui/swagger-ui-5.17.14/dist

生成物をローカルまたはデプロイ後にて確認お願いします。

lanexpr commented 3 weeks ago

ローカルで確認する場合same-originに関連するセキュリティ機能により正しく表示されないので、ブラウザの設定を変更する必要があると思います: https://qiita.com/nissuk/items/1ede2953a8661dc59214

なので、デプロイ後に確認するほうがよさそうです。