Is there a way to generate API doc for my app

Hello everyone,

Does anyone know if there is a built in feature in bubble allowing to publish a documentation for my App API (ie defining Auth method, public endpoints with json format etc…) automatically.

If not, how would you do that ?

Thanks !

1 Like

Hi @pro.sc.conseils :wave:
I think bubble recommends swagger for API documentation
https://manual.bubble.io/core-resources/api/introduction#swagger-specification

3 Likes

In addition to viquarahmed07 answer above:

If you deselect “Hide Swagger API documentation access” in Settings - API, Bubble will generate Swagger API spec for you.

  1. Deselect:

  1. Go to https://insertyourappname.bubbleapps.io/api/1.1/meta/swagger.json or https://insertyourappname.bubbleapps.io/version-test/api/1.1/meta/swagger.json to see the spec:

2 Likes

You can then copy and paste all that text into a swagger doc editor! Bam, you got sweet API documents nicely formatted for a human

3 Likes

Hey everyone,

thanks for your answer.
It worked well thanks !

I guess there is a way to organize this better : my data api endpoints are in raw list like below, not organized by data types. If you have the info on how to improve presentation i’ll listen :wink: else, this i already good !

Thanks again !

1 Like