Replace apivore with rswag for api tests

[yksflip]

This PR replaces apivore with rswag.
It's still in an early stage, but I thought it would be good to share some thoughts and the progress, as it will be quite a big changeset...

• moving to OpenAPI Spec 3.0.1
• there is a swagger ui which is routed by default from: http://localhost:3000/api-docs/index.html
• the swagger file moved from /docs/swagger.v1.yml to /swagger/v1/swagger.yml
• swagger file is generated by running RAILS_ENV=test rails rswag, should this be added to the CI?

ToDo's

• fix rubocop violations
  • config/routes.rb:1:1: C: Metrics/BlockLength: Block has too many lines. [212/210]
  • spec/support/api_helper.rb:8:9: C: RSpec/VariableName: Use snake_case for variable names.
• rswag translation api endpoints
  • /user
    • /user/financial_overview
    • /user/financial_transactions
    • /user/group_order_articles
  • /financial_transactions
  • /orders
  • /order_articles
  • /article_categories
  • /financial_transaction_classes
  • /financial_transaction_types
  • /config
  • /navigation

[wvengen]

Ah, very very good to see this!
apivore was a big blocker for the Rails upgrade, and I think your approach is perfectly fine. Just too bad that we now have a generated file in the tree. Perhaps we'd best start with CI validating that the swagger file isn't out-of-date (either with timestamps, or by generating and detecting changes - probably the latter).

For my point of view, please continue in this direction :) 👍

[yksflip]

thanks for your feedback!
Do we actually need to have the swagger.yaml in the tree?
We could generate it in the Dockerfile at build time and we could reference in the docs to smth like https://app.foodcoops.net/api-docs/index.html or any other demo instance.

There's one thing left:
financial_transactions_controller.rb doesn't trows an 422 Error for invalid params. See: https://github.com/foodcoops/foodsoft/pull/969/files#diff-1c933b556e77c0e5911d866a7c6fbd16b6ed8f195f40e2f079703ae4c074c03fR48
I guess this would be another issue?

Beside of that I think this rswag stuff seems to work! I know this is quite a lot to review, so I'd be happy for any ideas how we can merge this best.

[yksflip]

I've created follow-up issues for the bug in the financial_transaction controller (see todo in the spec file) and for generating the swagger.yml at build time in the Dockerfile.
I think this can be merged now.
@lentschi do you wan't to have a look first or should I just move on?
Final thoughts anyone?

[carchrae]

i haven't reviewed this, but i'm excited to try it out some time. i would much rather have a vue.js app running as my customised front end rather than making lot of changes to haml files and then having a nightmare upgrading when a new foodsoft version comes out.

so, thank you. also, glad you are using swagger. i haven't used it in ruby, but i have used it in nodejs and java projects before.