Swagger -> Markdown

Question

Swagger -> Markdown

ageddesi opened this issue 2 years ago · 6 comments

Currently our API uses OpenAPI commenting to generate a swagger document.
I would like this to be converted into markdown so that we can use it as pages on the website itself and make the pages fit in with the rest of the sites design.

Answer 1 · 2022-10-14T16:14:02.000Z

Hey @ageddesi I want to work on this task. Please assign this task to me.

Answer 2 · 2022-10-14T16:20:55.000Z

Awesome. :) 😀

Answer 3 · 2022-10-17T21:46:28.000Z

@ageddesi - is this in addition to the existing swagger document, or would the markdown replace the existing swagger document? I kind of like swagger as an interface to directly use the API right in the browser.

If you're going for markdown pages - can I suggest that we look at Hugo / GitHub pages for storing that markdown content?

Answer 4 · 2022-10-18T08:58:41.000Z

If we can style the docs that would be ace. I wanna bring them inline with the main site design.

Answer 5 · 2022-10-18T12:09:39.000Z

@ageddesi Can we have a meet regarding this task. I need to discuss the requirements.

Answer 6 · 2022-10-19T07:41:39.000Z

Hi @sirdikshit feel free to join us on discord to talk this through. https://discord.gg/vKrWtQ7G