> 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/gaido/previewing-docs.md).
# ドキュメントのプレビュー
`doc/openapi.json`を生成したら、いくつかの無料ツールで人間が読みやすいHTMLページとしてレンダリングできます。
## Redoc（推奨 — サーバー不要）
```sh
npx @redocly/cli build-docs doc/openapi.json -o doc/openapi.html
open doc/openapi.html
```
`@redocly/cli`は自己完結したHTMLファイルを生成します。読み込み時にインターネット接続は不要で、CIアーティファクトとしてコミットまたは添付しやすいです。
開発中にライブリロードで確認するには:
```sh
npx @redocly/cli preview-docs doc/openapi.json
```
ブラウザで`http://127.0.0.1:8080`を開きます。specファイルが変更されるとページが自動更新されます。
## Swagger UI（Docker）
```sh
docker run --rm -p 8081:8080 \
-e SWAGGER_JSON=/spec/openapi.json \
-v "$PWD/doc:/spec" swaggerapi/swagger-ui
```
`http://localhost:8081`にアクセスします。Swagger UIでは各オペレーションを展開して、実行中のサーバーに対してリクエストを試せます。
## Stoplight Elements（Webコンポーネント）
既存のRailsビューにドキュメントを埋め込む場合:
```html
API Docs
```
コントローラからspecファイルを配信します。
```ruby
# config/routes.rb
get "/openapi.json", to: "docs#spec"
get "/docs", to: "docs#index"
# app/controllers/docs_controller.rb
class DocsController < ApplicationController
def spec
render file: Rails.root.join("doc/openapi.json"), content_type: "application/json"
end
end
```
## 読みやすさのためのYAML出力
specをYAMLで読みたい場合（PRのdiffがより見やすくなります）:
```ruby
config.output_path = "doc/openapi.yaml"
```
上記3つのビューアはJSONとYAMLどちらにも対応しています。
## CIアーティファクト
プルリクエストと一緒にspecをCIアーティファクトとしてアップロードできます。
```yaml
# .github/workflows/ci.yml（例）
- name: Generate OpenAPI spec
run: bundle exec rake openapi:generate
- name: Upload spec
uses: actions/upload-artifact@v4
with:
name: openapi-spec
path: doc/openapi.json
```
## ドリフト検知
specをバージョン管理にコミットして、予期しない変更があった場合にCIを失敗させます。
```yaml
- run: bundle exec rake openapi:generate
- run: git diff --exit-code doc/openapi.json
```
これにより、開発者がコントローラやビューを変更してspecを再生成し忘れたケースを検知できます。
---
# 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/gaido/previewing-docs.md?ask=&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.