質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

新規登録して質問してみよう
ただいま回答率
85.48%
Swagger

Swaggerは、REST APIを定義するための標準仕様に基づいて構築された一連のオープンソースツール。REST APIの設計や構築、文書化、使用に便利なツールを提供。Swagger Specを書くことでドキュメント生成まで自動的に行い、さらにドキュメントから実際のリクエストを投げられます。

JSON

JSON(JavaScript Object Notation)は軽量なデータ記述言語の1つである。構文はJavaScriptをベースとしていますが、JavaScriptに限定されたものではなく、様々なソフトウェアやプログラミング言語間におけるデータの受け渡しが行えるように設計されています。

Ruby on Rails

Ruby on Railsは、オープンソースのWebアプリケーションフレームワークです。「同じことを繰り返さない」というRailsの基本理念のもと、他のフレームワークより少ないコードで簡単に開発できるよう設計されています。

Q&A

0回答

737閲覧

Swagger JSON(JSON Schema)からexample valueのJSONデータ(テスト用JSONパラメータ)を生成したい

MAOAU

総合スコア11

Swagger

Swaggerは、REST APIを定義するための標準仕様に基づいて構築された一連のオープンソースツール。REST APIの設計や構築、文書化、使用に便利なツールを提供。Swagger Specを書くことでドキュメント生成まで自動的に行い、さらにドキュメントから実際のリクエストを投げられます。

JSON

JSON(JavaScript Object Notation)は軽量なデータ記述言語の1つである。構文はJavaScriptをベースとしていますが、JavaScriptに限定されたものではなく、様々なソフトウェアやプログラミング言語間におけるデータの受け渡しが行えるように設計されています。

Ruby on Rails

Ruby on Railsは、オープンソースのWebアプリケーションフレームワークです。「同じことを繰り返さない」というRailsの基本理念のもと、他のフレームワークより少ないコードで簡単に開発できるよう設計されています。

0グッド

0クリップ

投稿2021/11/18 10:57

編集2021/11/25 01:59

前提・実現したいこと

railsで、jsonで書いたswaggerからSwagger UIの「example value」にあたるリクエストパラメータのjsonデータを作成したいのですが、もしもgemなどで簡単にできる良い方法があれば教えていただきたいです。

試したこと

色々検索してみましたがそれらしきものが見当たりませんでした・・・

補足情報(FW/ツールのバージョンなど)

Ruby 2.6
Rails 6

追記

JSON::Fuzz::Generator というgemを見つけてこれだ!と思ったのですが、思うように変換できず・・・

例)
swaggerからリクエスト定義部分を抽出

json

1{ 2 "additionalProperties": false, 3 "required": [ 4 "hoge_tables" 5 ], 6 "properties": { 7 "hoge_tables": { 8 "type": "array", 9 "items": { 10 "type": "object", 11 "additionalProperties": false, 12 "required": [ 13 "hoge_id", 14 "hoge_num" 15 ], 16 "properties": { 17 "hoge_id": { 18 "type": "integer", 19 "format": "int64", 20 "example": 1 21 }, 22 "hoge_num": { 23 "type": "number", 24 "format": "float", 25 "minimum": 0.0001 26 } 27 } 28 } 29 } 30 } 31}

こちらをJSON::Fuzz::Generator.default_paramで変換すると

json

1{"hoge_tables"=>{"hoge_id"=>86, "hoge_num"=>0.0001}}

とarrayが無視されて出力されますが、Swagger UIでは

json

1{ 2 "hoge_tables": [ 3 { 4 "hoge_id": 1, 5 "hoge_num": 0 6 } 7 ] 8}

とhoge_tablesがスキーマの指定通り配列で出力されており、こちらのSwagger UIの結果の形で出力されて欲しいのですが・・・

気になる質問をクリップする

クリップした質問は、後からいつでもMYページで確認できます。

またクリップした質問に回答があった際、通知やメールを受け取ることができます。

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

guest

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

まだ回答がついていません

会員登録して回答してみよう

アカウントをお持ちの方は

15分調べてもわからないことは
teratailで質問しよう!

ただいまの回答率
85.48%

質問をまとめることで
思考を整理して素早く解決

テンプレート機能で
簡単に質問をまとめる

質問する

関連した質問