OpenAPITools / OpenAPITools/openapi-generator

Generated static HTML documentation looks barebones

Open
#2,235 2 comments 23 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Description

The generated HTML documentation looks pretty barebones, ideally it should look like the preview on https://editor.swagger.io/.

I generated the HTML documentation for the petstore example with those two commands:

$ docker run -v /tmp/openapi:/shared --rm -it openapitools/openapi-generator-cli:latest generate --generator-name html --output /shared --input-spec https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml --skip-validate-spec

petstore-html.tar.gz

screenshot-1551117217

$ docker run -v /tmp/openapi:/shared --rm -it openapitools/openapi-generator-cli:latest generate --generator-name html2 --output /shared --input-spec https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml --skip-validate-spec

petstore-html2.tar.gz

screenshot-1551117234

openapi-generator version

Whatever latest is on https://hub.docker.com/r/openapitools/openapi-generator-cli/tags.

OpenAPI declaration file content or url

The petstore example: https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml

Command line used for generation

See docker commands above.

Steps to reproduce

See above.

Suggest a fix/enhancement

Templates need to get some styling.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Run the documented Docker commands for the html and html2 generators with the linked Petstore OpenAPI example, then compare both outputs with the Swagger Editor preview. Inspect the templates used by those generators; done means the generated static documentation has styling comparable to the referenced preview.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, openapi
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.