Can Swagger Editor's HTML output be exported?

15,527 views
Skip to first unread message

Sean Bigdatafun

unread,
Oct 10, 2014, 2:15:40 PM10/10/14
to swagger-sw...@googlegroups.com
Hey, many thanks to HelloReverb folks to provide info for me to get started :-).

Here is what I want: Input of YAML --> an HTML output (for me to use as documentation on my site), and I know that Swagger Editor can help me to generate a .json output from the YAML design doc. And I know I could use that .json file to feed into Swagger-Codegen (./bin/static-docs.sh) to generate HTML docs.

However, I really like the styles, content and pretty much everything of the in-place generated HTML by Swagger-Editor, as shown at http://editor.swagger.wordnik.com/#/

Can I somehow export the Swagger-Editor generated HTML somehow directly? (once I have it, I may manipulate the CSS etc. a bit, but probably not much)

Sean










Ron

unread,
Oct 10, 2014, 6:01:58 PM10/10/14
to swagger-sw...@googlegroups.com

--
You received this message because you are subscribed to the Google Groups "Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

tony tam

unread,
Oct 11, 2014, 5:20:14 PM10/11/14
to swagger-sw...@googlegroups.com
Hi, if you want static HTML, you would have to use the codegen project and make your own templates.  It's quite easy to do so, but there isn't one that looks just like the swagger editor panel.

I suggest taking at look at the codegen version for swagger spec 2.0 from here:


And the templates that are used for static html:


You should be able to easily build what you're after from there.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggersocket+unsub...@googlegroups.com.

flindby

unread,
Sep 17, 2015, 3:35:23 AM9/17/15
to Swagger
Hi,

I'm new to Swagger and really love the editor, yaml syntax and the live HTML-output. 
I wonder if there is some new tool or option that makes it possible to get the same "look-and-feel" as the editor generates, or if there will be?

Otherwise I might consider using the codegen, but it seems overkill to just get some plain html/javascript that is already "available" in the editor? Or maybe I miss some fundamental understanding about swagger?


Regards
Filip

Ron Ratovsky

unread,
Sep 17, 2015, 3:39:33 AM9/17/15
to Swagger
Right now it is not available and not sure if/when it will be. The codegen is your current option, though you can still use swagger-ui, and if you want to disable the sandbox you can configure it that way.

To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.



--
-----------------------------------------
http://swagger.io
https://twitter.com/SwaggerApi
-----------------------------------------

flindby

unread,
Sep 17, 2015, 3:42:44 AM9/17/15
to Swagger
Allright, thanks for the fast reply!

Regards
Filip
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggersocket+unsub...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggersocket+unsub...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

Nils Knappmeier

unread,
Sep 21, 2015, 3:21:08 AM9/21/15
to Swagger
I would like to point you to bootprint-swagger, which is my private project and not officially related to swagger.io, but it can convert almost the whole 2.0 spec into readable html. The parts that are missing are listed as open issues on github. If something is not working, you can create an issue as well. I'll try to resolve them quickly.

Ron Ratovsky

unread,
Sep 21, 2015, 7:22:25 AM9/21/15
to Swagger
That's very cool, Nils! Thanks for sharing.

If you'd like to add it to the list of open source tools in swagger.io, let me know.

On Mon, Sep 21, 2015 at 10:21 AM, Nils Knappmeier <nkn...@gmail.com> wrote:
I would like to point you to bootprint-swagger, which is my private project and not officially related to swagger.io, but it can convert almost the whole 2.0 spec into readable html. The parts that are missing are listed as open issues on github. If something is not working, you can create an issue as well. I'll try to resolve them quickly.

--
You received this message because you are subscribed to the Google Groups "Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

Nils Knappmeier

unread,
Sep 21, 2015, 12:52:43 PM9/21/15
to Swagger
Hi Ron,

glad you like it. I'd be happy to have it listed on swagger.io. I just haven't found the right moment to tell you about it.

Cheers, 
  Nils




Ron Ratovsky

unread,
Sep 21, 2015, 1:04:23 PM9/21/15
to Swagger

--
You received this message because you are subscribed to the Google Groups "Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

flindby

unread,
Sep 25, 2015, 10:35:22 AM9/25/15
to Swagger
Ah, thanks Nils, looks really neat. 
Any plans to generate the documentation with the same look-and-feel as the swagger-editor uses?

Regards
Filip
Reply all
Reply to author
Forward
0 new messages