twskj/pretty-swag

Support for version 3

Opened this issue · 11 comments

edahlseng commented

Thoughts on providing support for version 3 of the OpenAPI specification?
https://blog.readme.io/an-example-filled-guide-to-swagger-3-2/

twskj commented

Thanks for the info. I'll look into it.

It looks like the new spec is trying to describe the same thing in a different format. I think all we need just a new parser for v3.

  • 👍1
jitbasemartin commented

Hello
Have you time schedule to do that ? Or news ?
Thanks

twskj commented

been busy lately but should be able to work on this project next month (hopefully)
PR always welcome too :-)

GMishx commented

Hey I am willing to work on this. But sadly I am "brand new" to node. So, it will be really helpful if you can give me some pointers.

twskj commented

Hey Gmishx,
Thanks I definitely could use your help. I'm really short on time these days.
Node wise don't worry about it. Keep things simple and clear that's what I focus on.

So you want to look at the parse function make sure you check v2 / v3 appropriately. Then simply make parseV3 function.

In parseV3, you want to start by getting a structure and start filling in information from json input.
At the end, you just have to call livedoc to generate an output html

I feel like many things are similar with V2 but haven't had time to look at V3 Schema closely

GMishx commented

Thanks for the pointers @twskj. I am trying to get the hang of Node.

I kind of got the idea how you wrote the parser and have confidence that can write it for V3 as well.

theletterf commented

Has this been solved?

twskj commented

Still in WIP

abarstow commented

👍 re supporting "openapi":"3.0.1"