Mocked-API icon indicating copy to clipboard operation
Mocked-API copied to clipboard

Published 20 hours ago • verified publisher icon ageddesi

Swagger -> Markdown

Open ageddesi opened this issue 1 year 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.

ageddesi avatar Oct 13 '22 18:10 ageddesi

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

sirdikshit avatar Oct 14 '22 16:10 sirdikshit

Awesome. :) 😀

ageddesi avatar Oct 14 '22 16:10 ageddesi

@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?

computamike avatar Oct 17 '22 21:10 computamike

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

ageddesi avatar Oct 18 '22 08:10 ageddesi

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

sirdikshit avatar Oct 18 '22 12:10 sirdikshit

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

ageddesi avatar Oct 19 '22 07:10 ageddesi