https://github.com/onukura/gitbucket-swagger-plugin

swagger (opeapi) file rendering plugin for GitBucket
https://github.com/onukura/gitbucket-swagger-plugin

gitbucket gitbucket-plugin

Last synced: 3 months ago
JSON representation

swagger (opeapi) file rendering plugin for GitBucket

• Host: GitHub
• URL: https://github.com/onukura/gitbucket-swagger-plugin
• Owner: onukura
• License: apache-2.0
• Created: 2020-06-03T17:26:32.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-11-22T15:32:41.000Z (over 3 years ago)
• Last Synced: 2025-01-07T20:01:00.317Z (5 months ago)
• Topics: gitbucket, gitbucket-plugin
• Language: Scala
• Homepage:
• Size: 3.78 MB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gitbucket-swagger-plugin

[![Build Status](https://travis-ci.org/onukura/gitbucket-swagger-plugin.svg?branch=master)](https://travis-ci.org/onukura/gitbucket-swagger-plugin)

A GitBucket plugin for rendering swagger (openAPI) file using [swagger-ui](https://github.com/swagger-api/swagger-ui).

## Screenshot

![screenshot](https://github.com/onukura/gitbcket-swagger-plugin/blob/assets/screenshot.png?raw=true)

## Install

1. Download *.jar from Releases.

2. Deploy it to `GITBUCKET_HOME/plugins`.

3. Restart GitBucket.

## Build from source

```sbt

sbt clean package

```

The built package is located at

`target/scala-2.13/gitbucket-swagger-plugin_2.13-{plugin-version}.jar`.

```sbt

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.

```bash

"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](https://github.com/swagger-api/swagger-ui/releases/tag/v3.49.0).

For supported version fields of swagger, please see [compatibility](https://github.com/swagger-api/swagger-ui#compatibility).

## Version

Plugin version|GitBucket version

:---|:---

1.0.x |4.32.x -