diff mbox series

[meta-webserver] swagger-ui: OpenAPI (aka swagger) website (v5.17.14)

Message ID 20241030192446.5964-1-jan.vermaete@gmail.com
State Under Review
Headers show
Series [meta-webserver] swagger-ui: OpenAPI (aka swagger) website (v5.17.14) | expand

Commit Message

Jan Vermaete Oct. 30, 2024, 7:24 p.m. UTC
New recipe with the static version of the Swagger UI.

This is *not* a NPM version of the website (swagger-ui, swagger-ui-dist, swagger-ui-react).
But the static release.

  Plain old HTML/CSS/JS (Standalone)

  The folder /dist includes all the HTML, CSS and JS files needed to run SwaggerUI on a static website or CMS, without requiring NPM.

      Download the latest release.
      Copy the contents of the /dist folder to your server.
      Open swagger-initializer.js in your text editor and replace "https://petstore.swagger.io/v2/swagger.json" with the URL for your OpenAPI 3.0 spec.

  -- https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/usage/installation.md#plain-old-htmlcssjs-standalone

Signed-off-by: Jan Vermaete <jan.vermaete@gmail.com>
---
 .../swagger-ui/swagger-ui_5.17.14.bb          | 22 +++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 meta-webserver/recipes-devtools/swagger-ui/swagger-ui_5.17.14.bb
diff mbox series

Patch

diff --git a/meta-webserver/recipes-devtools/swagger-ui/swagger-ui_5.17.14.bb b/meta-webserver/recipes-devtools/swagger-ui/swagger-ui_5.17.14.bb
new file mode 100644
index 000000000..de5437027
--- /dev/null
+++ b/meta-webserver/recipes-devtools/swagger-ui/swagger-ui_5.17.14.bb
@@ -0,0 +1,22 @@ 
+SUMMARY = "Visually render documentation for an API defined with the OpenAPI"
+DESCRIPTION = "\
+    Swagger UI allows anyone — be it your development team or your end consumers — to visualize and \
+    interact with the API’s resources without having any of the implementation logic in place. \
+    It’s automatically generated from your OpenAPI (formerly known as Swagger) Specification, \
+    with the visual documentation making it easy for back end implementation and client side consumption. \
+    "
+HOMEPAGE = "https://github.com/swagger-api/swagger-ui"
+SECTION = "net"
+LICENSE = "Apache-2.0"
+LIC_FILES_CHKSUM = "file://LICENSE;md5=3b83ef96387f14655fc854ddc3c6bd57"
+
+SRC_URI = "git://github.com/swagger-api/swagger-ui;branch=master;protocol=https"
+
+SRCREV = "74ed0adebfc9c8dd0de2bf8e81495b022a66c083"
+
+S = "${WORKDIR}/git"
+
+do_install() {
+    install -d ${D}${localstatedir}/www/openapi/static
+    cp -r ${S}/dist/* ${D}${localstatedir}/www/openapi/static
+}