oas_docsからopenapiに移行しました。

Makefile

@@ -83,3 +83,21 @@ run-swagger:
 openapi:
 	docker compose run --rm api bundle exec rake routes:oas:docs
 	docker compose run --rm api bundle exec rake routes:oas:build
+
+openapi-cli:
+	@if [ -z "$(cmd)" ]; then \
+		echo "Usage: make openapi-cli cmd=\"version\""; \
+		exit 1; \
+	fi
+	./scripts/openapi-generator $(cmd)
+
+openapi-generate:
+	spec=$${spec:-openapi/openapi.yml}; \
+	output=$${output:-api/generated/server}; \
+	generator=$${generator:-ruby-on-rails}; \
+	extra=$${extra:-}; \
+	./scripts/openapi-generator generate \
+	  -i $$spec \
+	  -g $$generator \
+	  -o $$output \
+	  $$extra

README.md

@@ -31,3 +31,18 @@ nuxt.js<br>
 
 ## セットアップ
 [git cloneをしたら](https://github.com/NUTFes/group-manager-2/wiki/git-clone-%E3%82%92%E3%81%97%E3%81%9F%E3%82%89)
+
+## OpenAPI Generator
+- `scripts/openapi-generator` で [openapi-generator-cli](https://github.com/OpenAPITools/openapi-generator) を Docker 経由で利用できます。
+- 初回実行時は `docker` がイメージ `openapitools/openapi-generator-cli:v7.5.0` を取得します。
+- 例: Rails サーバースタブを生成する場合
+  ```bash
+  scripts/openapi-generator generate \
+    -i openapi/openapi.yml \
+    -g ruby-on-rails \
+    -o api/generated/server
+  ```
+- 生成物の出力先はマウント済みのリポジトリ内なら自由に指定できます。
+- `make openapi-cli cmd="<コマンド>"` で CLI をそのまま呼び出せます（例: `cmd="version"`）。
+- `make openapi-generate` では `openapi/openapi.yml` を元に Rails サーバースタブを `api/generated/server` へ生成します。
+  - `spec`, `output`, `generator`, `extra` を渡すと動作を上書きできます。

api/Gemfile

@@ -50,7 +50,6 @@ group :development do
   # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
   gem 'spring'
   gem 'spring-watcher-listen', '~> 2.0.0'
-  gem 'r2-oas'
 end
 
 

compose.swagger.yml

@@ -5,6 +5,6 @@ services:
     ports:
       - "8004:8080"
     volumes:
-      - ./api/oas_docs/dist:/oas_docs
+      - ./openapi:/openapi
     environment:
-      SWAGGER_JSON: /oas_docs/oas_doc.yml
+      SWAGGER_JSON: /openapi/openapi.yml

api/oas_docs/src/info.yml → openapi/meta.yml

@@ -1,4 +1,5 @@
 ---
+openapi: 3.0.0
 info:
   title: OAS API Document Title
   description: |-
@@ -14,3 +15,15 @@ info:
     name: ''
     url: ''
   version: 1.0.0
+externalDocs:
+  description: ''
+  url: ''
+servers:
+- url: http://localhost:3000
+  description: localhost
+tags:
+- name: venue_map
+  description: venue_map description
+  externalDocs:
+    description: description
+    url: url

scripts/openapi-generator

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
+IMAGE="${OPENAPI_GENERATOR_IMAGE:-openapitools/openapi-generator-cli:v7.5.0}"
+
+if [ $# -eq 0 ]; then
+  set -- "help"
+fi
+
+exec docker run --rm \
+  -u "$(id -u):$(id -g)" \
+  -v "${ROOT_DIR}:/workspace" \
+  -w /workspace \
+  "${IMAGE}" "$@"