[2201.9.x] Generate and host SwaggerUI for the generated OpenAPI specification as a built-in resource

[ayeshLK]

Purpose

$subject

Fixes: #6622

Examples

• Run the Ballerina Snowpeak sample using bal run by enabling OAS generation.

configurable int port = 9090;

# A fake mountain resort
@openapi:ServiceInfo { embed: true }
@http:ServiceConfig { mediaTypeSubtypePrefix: "vnd.snowpeak.resort", cors: { allowOrigins: ["*"] }}
service /snowpeak on new http:Listener(port) {
  // ...
}

• Access http://localhost:9090/snowpeak/swagger-ui-dygixywsw URL on your browser.

• Following is a sample screenshot for a service which contains an invalid OpenAPI definition.

Checklist

• Linked to an issue
• Updated the changelog
• Added tests
• Updated the spec
• Checked native-image compatibility
• Checked the impact on OpenAPI generation

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

[TharmiganK]

LGTM

[dulajdilshan]

What is the reason for this random string value dygixywsw?

[TharmiganK]

What is the reason for this random string value dygixywsw?

This is to make the URL unique. Please refer to this comment: ballerina-platform/ballerina-library#1616 (comment)