Enabling Swagger UI

By default, the Swagger user interface (UI) is disabled. However, you can enable it two ways: by using the helm install command or by modifying the custom values YAML file.

Using Helm Install command

You can enable the Swagger UI by specifying a parameter directly in the helm install command. This method is useful for quick setups or when you want to enable the Swagger UI without modifying the values file.

  1. Open the command-line interface.
  2. Run the helm install command with the additional parameter to enable the Swagger UI:

    helm install <release-name> <chart-name> --set swagger.enabled=true

    Replace <release-name> with the release name and <chart-name> with the Helm chart name.

Using a custom values YAML file

Alternatively, you can enable the Swagger UI by specifying a parameter in a custom values YAML file. This method is beneficial for maintaining configuration as code and for more complex setups.
  1. Create or edit the custom values YAML file.
  2. Add the following configuration to enable swagger UI:
    swagger:
  enabled: true
  3. Save the file.
  4. Run the helm install command and use the custom values file:

    helm install <release-name> <chart-name> -f custom-values.yaml