Docs Menu
API Developer Guide / middleware / pub / specs / swagger / v3 / GenerateSwagger

Service: GenerateSwagger

This service generates an OpenAPI document based on the specified fully qualified names (fqns) and offers the option to make it downloadable.

Input Parameter:

Name Type Description
fqns: String Array An array of fully qualified names (fqns) representing the components that contribute to the generation of the OpenAPI document.
isDownloadable: Boolean A boolean flag that, when set to true, indicates that the generated OpenAPI document should be available for download.

Output Parameter:

Name Type Description
openAPI: String The generated OpenAPI document. If isDownloadable is set to true, this document can be downloaded.