Generating API Documentation from Java Cloud Endpoint

I am looking for an efficient way to generate readable format API documentation from generated files from Cloud Endpoint (Java). Generated files: - my_api.api - my_api * .discovery

Something similar to this: - https://github.com/kevinrenskers/raml2html#example-output

Swagger, API plan, and RAML are all nice options, but don't seem to be well adapted to the API descriptor files generated by the endpoint.

What methods are you using?

+3


source to share


1 answer


Unfortunately we (Apiary) do not actually offer a code generation tool at this time for the Blueprint API.

If you are looking for a way to generate a description of your API from code, then API Blueprint is probably not the best choice, as we believe it should be a contract between all participants in the API design lifecycle. This is also the reason why we created a testing tool - Dredd - https://github.com/apiaryio/dredd



With Dredd, you can check that your API implementation matches your project. It doesn't make a lot of sense if the project is built from implementation.

Hope he clarifies.

+2


source







All Articles