Skip to content

Swagger docs don't show example request body #36

@KnowYourselves

Description

@KnowYourselves

Hello!

I have been having problems with the swagger documentation generated by this gem. Specifically the auto-generated swagger documentation doesn't show the body for the requests.

Version Information

  • OS: Windows 11, WSL2 with Ubuntu20.04
  • ruby: 2.7.4
  • node: 12.22.7
  • potassium: 6.4.0
  • power-api: 1.0.0

Steps to reproduce

  1. gem install potassium
  2. potassium create test-power-api
  3. App created with following options:
    image
  4. cd test-power-api
  5. bundle exec rails g model Banana size:float weight:float
  6. rake db:migrate
  7. bundle exec rails g power_api:controller Banana
  8. bundle exec rails rswag:specs:swaggerize
  9. bundle exec rails s
  10. Go to localhost:3000/api-docs

Expected result

The swagger documentation for POST /bananas should show an example body, for example, like the following documentation:

image
image

Actual result

The swagger documentation for POST /bananas doesn't show an example body:

image
image

Thanks!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions