I've tried using https://doctoolchain.github.io/docToolchain/ to create an HTML or PDF doc that includes a swagger/openapi yaml file. It looks like the only output for this is into confluence which also requires an additional confluence plugin. Is this the only option at this time? I am able to do other asciidoc and diagram formatting using docToolchain and I'd be very happy to include swagger. I can publish to confluence but cannot get either of the swagger plugins added to our system.
1
There are 1 best solutions below
Related Questions in OPENAPI
- How to assign label to nested Basemodel in pydantic with fastapi
- Export OpenAPI to native/plain javascript
- How to specify the client ID and redirect URI in Swagger OAuth2.0 configuration for Swagger UI?
- Mark OpenAPI schema enum value as deprecated
- Show "thrown error"/"console.log" at the swagger ui
- How can I remove the OPTIONAL value from a schema in Docusaurus using an OpenApi file?
- Only some generated OpenApi Angular service functions are not defined when executing in browser
- How to reference a model in a POST request body schema according to OpenAPI?
- Few enums have constants values in common, causing OpenAPI Generator to fail. How to put some of the model classes, types in different packages?
- Unmarshalling json into protobuf having oneof type
- Use of Interactive API documentation with OpenAPI GitLab
- Express server with OpenAPI specification with ES6+ on Windows doesn't accept nested routes
- Cannot use different request body options in the generated api from OpenAPI Spec?
- Type generation in openapi-fetch
- Using micronaut-openapi @ApiResponse @ExampleObject value with JSON string, attribute with null values are ommitted on openapi.yml
Related Questions in ASCIIDOC
- Is there a way to combine curly quotes and em dash in AsciiDoc?
- How do I include visible spaces in code listing in table
- Is there a way to render the document attributes of an asciidoc file and output to an adoc file?
- Ascii doc syntaxes not provide consistent output & not working as expected
- How do I add a "copy to clipboard" button block extension?
- Table in pdf, generated from Asciidoctor have word wrapping but the word becomes unsearchable
- Is there a (good) 3-way merge driver for ASCII-DOC files?
- How can I publish asciidoc containing plantUML digram to GitHub's Wiki
- How do I enable tabs in Asciidoc and Maven with asciidoctor-tabs and asciidoctor-maven-plugin?
- Render a PlantUML diagram in an asciidoc readme in GitLab
- How to modify the html template used by Jekyll AsciiDoc HTML generator
- Asciidoctor tables in docx no style
- I am getting `Error creating DOCX from AsciiDoc file` in IntelliJ Idea, How can this be resolved?
- What's the correct way to render Asciidoc HTML in Gatsby?
- How to include partial with different attributes and without empty lines
Related Questions in DOCTOOLCHAIN
- Doctoolchain Docker Container fails to pull in dependencies
- using plantuml %load_json in DocToolchain
- How can I use docToolchain with GitLab CICD pipeline?
- Does DocToolChain support Python?
- Running doctoolchain in Bamboo
- How can I include a swagger/openapi yaml file into doctoolchain and get a swagger-like output without using a confluence plugin?
- asciidoc, doctoolchain, target github readme.adoc - how to export asciidoc file containing includes into ONE file without include?
Trending Questions
- UIImageView Frame Doesn't Reflect Constraints
- Is it possible to use adb commands to click on a view by finding its ID?
- How to create a new web character symbol recognizable by html/javascript?
- Why isn't my CSS3 animation smooth in Google Chrome (but very smooth on other browsers)?
- Heap Gives Page Fault
- Connect ffmpeg to Visual Studio 2008
- Both Object- and ValueAnimator jumps when Duration is set above API LvL 24
- How to avoid default initialization of objects in std::vector?
- second argument of the command line arguments in a format other than char** argv or char* argv[]
- How to improve efficiency of algorithm which generates next lexicographic permutation?
- Navigating to the another actvity app getting crash in android
- How to read the particular message format in android and store in sqlite database?
- Resetting inventory status after order is cancelled
- Efficiently compute powers of X in SSE/AVX
- Insert into an external database using ajax and php : POST 500 (Internal Server Error)
Popular Questions
- How do I undo the most recent local commits in Git?
- How can I remove a specific item from an array in JavaScript?
- How do I delete a Git branch locally and remotely?
- Find all files containing a specific text (string) on Linux?
- How do I revert a Git repository to a previous commit?
- How do I create an HTML button that acts like a link?
- How do I check out a remote Git branch?
- How do I force "git pull" to overwrite local files?
- How do I list all files of a directory?
- How to check whether a string contains a substring in JavaScript?
- How do I redirect to another webpage?
- How can I iterate over rows in a Pandas DataFrame?
- How do I convert a String to an int in Java?
- Does Python have a string 'contains' substring method?
- How do I check if a string contains a specific word?
Beside being able to publish it to confluence, you could generate HTML or PDF files. For this to work it is necessary to configure it properly and to execute command for generating respective output format (generateHTML|generatePDF). Currently, result will be static (no interactive Swagger-UI page, so you will not be able to make any requests from generated output).
Regarding configuration, you would need to declare location of OpenAPI spec as json file in
config.groovy, like:InfoUrl and InfoEmail are just meta parameters which will be used for the HTML/PDF header.
Interactive SwaggerUI generation via docToolchain is one of the features we would like to implement soon, but unfortunately we can't give any ETA at the moment. Nevertheless, PRs at github project are welcomed :)