Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
curl -i -X PUT http://<IP-APPLIANCE>:8080/SignEngineWeb/rest/server-admin/change-apikey?newApiKey=NEW_API_KEY \
-H 'x-api-key: OLD_API_KEY'

How can enable opeapi and swagger?

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

Code Block
-e SPRINGDOC_API_DOCS_ENABLED=true

The run command, will be:

Code Block
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:

Description

Allows to enable swagger ui

HttpMethod

PUT

Path

swagger

Header

NAME: “x-api-key”

VALUE: “API_KEY”

Response

Return the status code 200

Below you can find an example using curl:

Code Block
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:

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

While the swagger endpoint will be published at this endpoint:

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

How can disable opeapi and swagger?

...

Or you can use a dedicated endpoint to enable it:

Description

Allows to enable swagger ui

HttpMethod

PUT

Path

swagger

Header

NAME: “x-api-key”

VALUE: “API_KEY”

Response

Return the status code 200

Below you can find an example using curl:

...