Generate the OpenAPI Document

You can generate the OpenAPI document directly from a server running SignServer, as long as the application server supports this feature. This page provides configuration examples for enabling and retrieving the OpenAPI document.

Enable MicroProfile OpenAPI in WildFly

Using JBoss CLI, enable the extension and subsystem, and then restart the application server:

CODE

/extension=org.wildfly.extension.microprofile.openapi-smallrye:add()
/subsystem=microprofile-config-smallrye:add()
/subsystem=microprofile-openapi-smallrye:add()
reload

After restarting the application server and deploying SignServer, the OpenAPI document can be obtained from /signserver/openapi (for YAML format) or /signserver/openapi?format=JSON (for JSON format).