OpenAPITools / openapi-generator

OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)
https://openapi-generator.tech
Apache License 2.0
22.06k stars 6.62k forks source link

[REQ] General improvement of AsciiDoc generation #11396

Open lfvjimisola opened 2 years ago

lfvjimisola commented 2 years ago

The generated AsciiDoc output is not complete if you compare it to standard swagger.ui (e.g Petstore). Missing things are e.g.

and other such as

Describe the solution you'd like

Update mustaché templates to output more of the information in OpenAPI spec file when generating AsciiDoc.

Describe alternatives you've considered

None other than completely manual writing.

osfameron commented 2 years ago

EDIT: deleted grumble about passthrough of notation, which is related to https://github.com/OpenAPITools/openapi-generator/issues/9324

But... 👍 yes please, this general improvement would be very useful!

cpkio commented 2 years ago

It would be nice to expose to Mustache temlplates:

lfvjimisola commented 2 years ago

It would be nice to expose to Mustache temlplates:

  • tags descriptions
  • security schemes descriptions

We are actually considering to leave Open API Tools and create our own jinja2 templates instead due to Open API Tools using Mustache which is logic less.

lfvjimisola commented 2 years ago

Our work with our own jinja2 template for OpenAPI Spec to AsciiDoc using jinja2 has started. We are hoping to release it as open source.

dustinmoris commented 5 months ago

@lfvjimisola any updates on your open source project?

lfvjimisola commented 5 months ago

@lfvjimisola any updates on your open source project?

Yes, see: https://github.com/luftfartsverket/openapi-to-asciidoc