Add SwaggerUi to replace Apiary

[blacksam07]

Board:

• Ticket Replace Apiary with self hosted SwaggerUI

---

Description:

• Use Rswag to expose generated swagger documentation
• Expose api-docs endpoint with basic-auth

---

Notes:

• Create a PR in rspec-openapi to include the project title

---

Tasks:

• Expose generate openapi.yaml doc with SwaggerUI
• The API Docs can be accessed through the Rails app
• The API Docs are not publicly accessible

---

Risk:

---

Preview:

[santib]

Apiary should no longer be mentioned in the README. Also, please add something in docs/api_documentation.md about the API Docs UI

[JulianPasquale]

What if we have both? public and private endpoints?

[blacksam07]

Is the way that rswag works, we need to define the API endpoints that will use it for UI section

[JulianPasquale]

Not sure if that answers my question.
If we build an app that has public endpoints, we need to also have a "public" documentation that anyone can see in order to understand how the API works.

So the question is, is it possible to only scope the auth to a subset of our endpoints and not the whole app?

[blacksam07]

@JulianPasquale Oh Oh, I understood that you are asking about rswag sorry

• I'm not sure, but I looked in the Swagger documentation and didn't find anything about adding auth only for a group of endpoints, also following the ticket scope I included the authorization here, but we can disable it by setting the value to "false". `

[JulianPasquale]

Cool. I think it would be nice to explore it so we can allow the mix of public and private docs. Not a blocker since auth can be disabled 👍

[santib]

I think this is a good discussion, maybe we can follow up in a meeting? I think what we need to answer is: who are we expecting to be the consumers of these endpoints?

• Frontend devs?
• Backend devs from other teams/apps?
• External products/services?

[santib]

Great job, thanks for bringing this improvement to the rails_api_base.

Last thing: remove the reference to Apiary in the README.md

Thanks!