Java或JavaScript库可从Swagger，RAML或API蓝图生成HTML

Question

Problem:

I am searching for a library in Java or JavaScript (or maybe Scala) which is able to generate an HTML representation of Swagger, RAML or API Blueprint input.

Background:

The idea is to use it as a part of a (Play Framework) web app serving as an API catalog. API specifications would be added by users of the API catalog and resulting HTML representations would be generated/displayed.

It would give extra value if a API specification stub also is possible to create using a Java API. The API catalog web app has a data model which I would like to use when generating the API stubs.

Furthermore, it would give extra value if the same (or related another) library provided a nice HTML editor of the API specification language (Swagger, RAML, API Blueprint etc) supporting the user while editing.

Answer 1

Swagger offers a set of tools to do it.

Swagger-Core will enable you to produce Swagger documentation from your Play code. This is done at runtime and will change as your application changes.

Swagger-UI will read such docs and display them in an HTML format. It also allows you to execute the operations and has integration with security mechanisms if needed. The UI can be customized to have the look-and-feel of your application (like many have done so far).

Swagger-Editor allows for direct editing of Swagger documentation with interactive side-by-side view of the docs in an HTML format.

Swagger-Codegen can take such a documentation and generate both client and server code. You can customize the templates to suit your needs.

Answer 2

There are several tools for for generating HTML from an API Blueprint, one of which is in Coffeescript and is called Aglio. You can see all of the tools here:

http://apiblueprint.org/

Also, Apiary is a service that uses API Blueprint and can be used for editing and hosting generated documentation, hooking up with Github to auto-generate from commits, providing some mocking APIs and some other cool stuff for teams and enterprises. You could check it out if you're wanting a solid service for your API documentation.

Answer 3

For RAML you have: - https://github.com/kevinrenskers/raml2html - https://github.com/mikestowe/php-raml2html

Give those a try ;)