...

And check if the field “global” is “UP”

Administration

Anchor
47912127-c510-4b78-8fc4-66cdfc1943a7 47912127-c510-4b78-8fc4-66cdfc1943a7

Below will be described the methods used to manage the configurations.

...

How can enable opeapi and swagger?

By default, for security reason openapi and swagger are disabled. if If you need to enable. you should add this field to docker run:

...

docker run -d --name NAME_OF_ISTANCE -v VOLUME_NAME:/opt/sws/custom -e SPRINGDOC_API_DOCS_ENABLED=true -p 8080:8080 namirial/sws:latest

Or you can use a dedicated endpoint to enable it:

Below you can find an example using curl:

curl -i -X PUT http://<IP-APPLIANCE>:8080/SignEngineWeb/rest/server-admin/swagger \
-H 'x-api-key: API_KEY'

Once complete the request, you must restart the service (in case on SWS standalone) or restart the docker image

At this link will be published the OPENAPI endpoint:

 http://<IP-APPLIANCE>:8080/SignEngineWeb/rest/openapi

While the swagger endpoint will be published at this endpoint:

http://<IP-APPLIANCE>:8080/SignEngineWeb/rest/openapi-ui.html

How can disable opeapi and swagger?

If you need to enable. you should add this field to docker run:

-e SPRINGDOC_API_DOCS_ENABLED=true

The run command, will be:

docker run -d --name NAME_OF_ISTANCE -v VOLUME_NAME:/opt/sws/custom -e SPRINGDOC_API_DOCS_ENABLED=true -p 8080:8080 namirial/sws:latest

Or you can use a dedicated endpoint to enable it:

Below you can find an example using curl:

curl -i -X PUT http://<IP-APPLIANCE>:8080/SignEngineWeb/rest/server-admin/swagger \
-H 'x-api-key: API_KEY'

Once complete the request, you must restart the service (in case on SWS standalone) or restart the docker image

At this link will be published the OPENAPI endpoint:

...