Zenn
Open3

ReDocでAPI仕様書を作る

redoc
mizkomizko

ファイルを分割して管理・結合して表示

https://garafu.blogspot.com/2020/06/multi-file-openapi.html

Dockerで立ち上げる場合、対象のファイルが ./build/openapi.yml (結合で作成されたファイル)になるので、下記の書き換えを忘れないようにする

docker-compose.yml

volumes:
      - "./openapi.yml:/usr/share/nginx/html/openapi.yml"

↓

volumes:
      - "./build/openapi.yml:/usr/share/nginx/html/openapi.yml"
mizkomizko

API仕様書をHTMLで出力する

結局GithubActionsは未使用でコマンド実行するように対応した

GitHub Actions × GitHub Pages を使用としたメモ

1. github actions で workflow を作成して実行

下記のエラーが発生

Dependencies lock file is not found in /home/runner/work/shoppin_api/shoppin_api. Supported file patterns: package-lock.json,npm-shrinkwrap.json,yarn.lock

2. リポジトリの実行ディレクトリに package-lock.json を作成

  • workflowファイルで lockファイルを指定する
- name: Use Node.js ${{ matrix.node-version }}
   uses: actions/setup-node@v3
   with:
      node-version: ${{ matrix.node-version }}
      cache: 'npm'
      cache-dependency-path: {lockファイルが配置されているパス}/package-lock.json

3. Github Pages を使用するための準備

private ブランチのままGithubPagesを使用したかったので、下記を設定

  • Organizationsを作成
    • プランごとに1組織作成できるっぽい
    • ※ フリープランではpublicブランチにしないとGithub Pagesは使えない
  • 個人ブランチからorganizationsにリポジトリをimport

これ以降はまた機会があれば