Generating Swagger UI for Self-Hosted APIs

Summary

User inquires about the steps to generate Swagger UI for various APIs in a self-hosted Airbyte application.


Question

Hi All,
how can we generate Swagger UI for all APIs (config, public, etc)?
what are the steps required to do so in our self-hosted application?



This topic has been created from a Slack thread to give it more visibility.
It will be on Read-Only mode here. Click here if you want
to access the original thread.

Join the conversation on Slack

['swagger-ui', 'api', 'self-hosted', 'documentation']

You have all API endpoints in this https://reference.airbyte.com/reference/getting-started|documentation. Is there a specific reason you want to generate something using Swagger? AFAIK Airbyte doesn’t have docs for that.

thank you for replying. I see that you have sent me the API references for the cloud version. however, I am looking to generate swagger UI from my own local so that any changes I make or any additional APIs I create and update the openapi yaml for are reflected on my swagger UI…how can I do so?

I don’t believe there is documentation explaining how to rebuild the API today. If you’re going to undertake something like that, contributions are welcome to improve the current documentation.