Skip to content

Latest commit

 

History

History
54 lines (34 loc) · 1.41 KB

README.md

File metadata and controls

54 lines (34 loc) · 1.41 KB
Raw

gitbucket-swagger-plugin

Build Status

A GitBucket plugin for rendering swagger (openAPI) file using swagger-ui.

Screenshot

screenshot

Install

  1. Download *.jar from Releases.
  2. Deploy it to GITBUCKET_HOME/plugins.
  3. Restart GitBucket.

Build from source

sbt clean package

The built package is located at target/scala-2.13/gitbucket-swagger-plugin_2.13-{plugin-version}.jar.

sbt assembly

This makes the assembly package target/scala-2.13/gitbucket-swagger-plugin-{plugin-version}.jar for deployment.

Usage

This plugin process files only with its name in the following list.

"openapi.yml", "openapi.yaml", "openapi.Yaml", "openapi.YML", "openapi.json", "openapi.JSON",
"swagger.yml", "swagger.yaml", "swagger.Yaml", "swagger.YML", "swagger.json", "swagger.JSON"

Supported swagger file version

This plugin uses swagger-ui v3.49.0.

For supported version fields of swagger, please see compatibility.

Version

Plugin version GitBucket version
1.0.x 4.32.x -