Best Practices, Recommendations and Known Issues

For the optimal usage of Swagger UI, the following recommendations are made:

• The installation of the Swagger UI as a service on the same node as that of the Product 360 Server, prevents any latency on account on network and thereby would lead to quicker generation of metadata and OpenAPI specification.

• In case of repositories with complex metadata and large number of entities/sub-entities the following optimizations, through the Swagger UI configuration settings, could ensure timely generation of the specification:

  • Increasing the JVM heap size, recommended default value is 512mb.

  • Increasing the number of threads, recommended default value is 10 threads.

Additionally, the following limitations are known for the current version of Swagger UI:

• It currently supports only the List API and Management API components within Product 360

• Channel Entity as part of Product 360 10.1, is not yet supported