https://github.com/unionj-cloud/go-doudou-openapi-ui

OpenAPI3 Online Documentation UI
https://github.com/unionj-cloud/go-doudou-openapi-ui

openapi3 swagger swagger3 vuejs

Last synced: about 1 year ago
JSON representation

OpenAPI3 Online Documentation UI

• Host: GitHub
• URL: https://github.com/unionj-cloud/go-doudou-openapi-ui
• Owner: unionj-cloud
• License: mit
• Created: 2021-08-03T01:12:59.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-05-19T23:30:24.000Z (about 2 years ago)
• Last Synced: 2025-03-22T06:11:24.199Z (about 1 year ago)
• Topics: openapi3, swagger, swagger3, vuejs
• Language: Vue
• Homepage:
• Size: 21.7 MB
• Stars: 2
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README-zh.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# go-doudou-openapi-ui

This is an OpenAPI3.0 specification UI project written by vuejs+typescript stack inspired by [redoc](https://github.com/Redocly/redoc) . Currently, it supports json format spec only, yaml support is coming soon.

![example](./example.gif)

## Usage

Clone the repo.

```

git clone git@github.com:unionj-cloud/go-doudou-openapi-ui.git

```

Install dependencies and start the project, then browser will be opened automatically.

```shell

yarn install && yarn serve

```

Add `?docUrl=${OAS3_SPEC_LINK}` to `http://localhost:9527/#/index` and click `enter`, online documentation will display.  

NOTE: `${OAS3_SPEC_LINK}` must support cors visit, for example: `https://petstore3.swagger.io/api/v3/openapi.json`

## Screenshot

![screenshot](./screenshot.png)

![screenshot2](./screenshot2.png)

![screenshot3](./screenshot3.png)