> For the complete documentation index, see [llms.txt](https://tonystrawberry.gitbook.io/rails-openapi-generator/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tonystrawberry.gitbook.io/rails-openapi-generator/ja/hajimeni/installation.md).

# インストール

## 動作要件

* Ruby 3.0以上
* Rails 7.0以上
* [`rails_param`](https://github.com/nicolasblanco/rails_param) Gem（任意 — `param!`でパラメータを文書化する場合のみ必要）

## Gemfileに追加

```ruby
# Gemfile
gem "rails-openapi-generator"
```

インストール:

```sh
bundle install
```

GemはRailtieを自動登録します。コード内に`require`文を記述する必要はありません。

## rakeタスクの確認

```sh
bundle exec rake -T openapi
# rake openapi:generate  # Generate OpenAPI 3.1 spec
```

タスクが表示されない場合は、`railties`がGemをロードしているか確認してください。エンジンや非標準の構成では、タスク登録が実行される前に`require "rails_openapi_generator"`を明示的に呼び出す必要がある場合があります。

## JSONまたはYAML出力

出力フォーマットは`output_path`に設定したファイルの拡張子から自動判定されます。デフォルトはJSONです。どちらのフォーマットも追加のGemは不要で、RailsがstdlibとしてJSONとYAMLの両方を含んでいます。

## 次のステップ

[クイックスタート →](/rails-openapi-generator/ja/hajimeni/quick-start.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://tonystrawberry.gitbook.io/rails-openapi-generator/ja/hajimeni/installation.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.