問題タブ [rspec-api-documentation]

API ドキュメントを公開ドキュメントと開発者ドキュメントに分けようとしています。これにより、私以外の人に提供できる別のドキュメントを持つことができます。

このために、Rails とrspec_api_documentationとして知られる gem を使用していますが、動作させることができません。github ページ内で提供されている構成オプションが機能しないようです。

最初に自分のプロジェクトで試し、次にサンプル アプリケーションをチェックして、そこで変更を加えました。

受け入れ_ヘルパー.rb:

orders_spec.rb:

出力：

また、グループを削除しようとしdevelopersましたが、エラーは発生しませんが、生成されたファイルを/doc/api/public/index.html開くと、「サンプルアプリ API」という空のファイルになります。

助けていただければ幸いです。

テスト目的でコレクションを手動でシリアライズしたいと考えています。私はこれを試しました：

これはうまくいきません。ここでは単一のリソースしかシリアル化できないようです。すべての投稿のシリアル化されたコレクションを返すにはどうすればよいでしょうか?

rspec_api_documentation次のコードを使用して、これまでに持っている 2 つのバージョンのドキュメントを生成するために使用し、管理しています。

これらのドキュメントをレンダリングするために使用apitomeしていますが、これまでのところ、API 2 の 2 つのバージョンのルートをマウントする方法を見つけることができませんでした。

何か案は？

rspec_api_documentation を使い始めたばかりですが、API で動作させることができません。readme の最初の例と同じくらい基本的な単純な仕様を作成しましたが、エラーが発生し続けundefined method 'call' for nil:NilClass、何が問題の原因なのかわかりません。

完全なスタック トレースは次のとおりです。

スペックはこちら

そしてここにコントローラーがあります

私のAPIはlocalhost:3000/api/v1/usersの下にあります

どんな助けでも大歓迎

rspec_api_documentationgem を使用して、アプリケーション内の他のリソースのドキュメントを生成することに成功しました。

しかし、新しいリソースに対して同じことを行うと、JSON ファイルresponse_bodyは空になります (残りの JSON は存在しますが)。そして、なぜこれが起こっているのかわかりません。

生成された JSON の response_body:

出力された API ドキュメント:

私がやったこと：

• でエンドポイントをテストし、curlそれが完全な応答を返すことを確認できます (現在、ドキュメントを作成しようとしています)。
• 作成したnote_factory.rb
• の最初のブロックに追加@notes = create_list(:note, 1,...)されます (オブジェクトを作成することを確認するためにコンソールに出力されます)before(:all) donotes_spec.rb

以下もテスト用に作成。

RAD関連する JSON 応答が空になる原因となる、何が欠けているのか混乱しています。

誰にもこれを引き起こす可能性のあるアイデアはありますか?

rspec_api_documentation を使用して aptitome をセットアップする手順に従っていると、次のエラーが表示されます。

これを修正するにはどうすればよいですか?