API doc generation questions

[Kai Hendry]

Hey guys,

Swagger looks like a more useful JSON schema. I like it! Discovered it via AWS's API gateway.

I generated http://s.natalian.org/2016-04-25/v.html (whoa, XHTML in 2016!)  from http://s.natalian.org/2016-04-25/v.yaml

java -jar swagger-codegen-cli-2.1.6.jar generate -i ~/tmp/vanilla-php-feedback-form/swagger.yaml -l html -o feedbackdocs

Is there a Swagger doc generate that doesn't use Java btw? I could figure out how to generate docs from http://editor.swagger.io/#/ which is promising. Though I can't see to edit in Chrome, only Firefox.

Referring back to http://s.natalian.org/2016-04-25/v.html 

Why is there a duplicate Table of Contents? 

Also don't quite understand these {Access,Methods} headers.

That "(feedbackFeedbackPhpPost)" line is fugly. Why?

Why isn't email defined as an email type?

I don't like the Up links. It's just noise. It's 2016, I think most developers know about PgUp & Home now.

Are there different templates folks use to customise & inject their company logo & sucks?

Had a look on Github but didn't find anything inspiring. :) https://github.com/search?q=swagger+-l+html&ref=simplesearch&type=Code&utf8=%E2%9C%93

Many thanks in advance for any hints!

[Ron Ratovsky]

The HTML templates generated by the codegen can be customized however you want – the provided one is there as a reference.

The online editor uses the codegen to generate the HTML and is equivalent to using it directly (it just uses the online service).

You can also look into https://github.com/swagger-api/swagger-ui/ for a more complete solution.

--
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.