📖
楽にOpenAPIをRedocで確認する!
やりたかったこと
楽に単体のOpenAPIファイルをRedocで確認したい!
# example
redoc ./openapi.yaml
or
redoc ./openapi.yml
or
redoc ./openapi.json
実行イメージ
実行するとhttpでListenするのでhttp://localhost:8070にアクセスする
$ redoc ./openapi.yaml
$ # Listen on http://localhost:8070
どうやるか
required
- docker
- zx(https://github.com/google/zx)
# エイリアスの方がいいかも
echo "zx /usr/local/bin/redoc.mjs --path \$1"| sudo tee /usr/local/bin/redoc
sudo chmod +x /usr/local/bin/redoc
# 下記の内容をコピペする
sudo vi /usr/local/bin/redoc.mjs
sudo chmod +x /usr/local/bin/redoc.mjs
#!/usr/bin/env zx
void async function () {
const ext = argv.path.split('.')[1]
const path = require("path");
const absPath = path.resolve(argv.path);
await $`# Listen on http://localhost:8070`
await $`docker run -it --rm -p 8070:80 -v ${absPath}:/usr/share/nginx/html/openapi.${ext} -e SPEC_URL=openapi.${ext} redocly/redoc`
}()
Discussion