Closed3

api blueprint -> openapi(swagger) メモ

rrihrrih
- doc
  - hoge
    - users.apib
    - posts.apib
    - ...
    - comments.apib
  - fuga
    - ...
    - works.apib
  - index.apib

のような階層の API Blueprint を OpenAPI に変換したい

rrihrrih

js ライブラリの apib2swagger でやれそうだけどディレクトリ単位で一括で変換はできなそう
https://github.com/kminami/apib2swagger

% ls
hoge
fuga
index.apib
% apib2swagger -i ./hoge/users.apib --yaml -o ./hoge/users.yaml

一つずつの変換

rrihrrih

結論

  • スクリプトでapib2swagegerをディレクトリ内全てのファイルに対して実行してOpenAPI(.yaml)を作成
  • root になる index.yaml をホスティングする s3 バケットを作成(ip制限を設ける)
  • GitHub のリポジトリの Settings から Repository secrets にアクセスキーとアクセスシークレットを設定しておく
  • GitHub Actionsで実行するIAMユーザにPutObjectを付与するポリシーを設定
このスクラップは2023/03/16にクローズされました