Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/data-fair/openapi-viewer
Browse and test a REST API described with the OpenAPI 3.0 Specification
https://github.com/data-fair/openapi-viewer
api api-documentation openapi openapi3 swagger swagger-ui
Last synced: about 2 months ago
JSON representation
Browse and test a REST API described with the OpenAPI 3.0 Specification
- Host: GitHub
- URL: https://github.com/data-fair/openapi-viewer
- Owner: data-fair
- License: agpl-3.0
- Created: 2017-03-14T18:12:56.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-12-06T13:44:39.000Z (about 1 year ago)
- Last Synced: 2024-06-16T05:28:51.313Z (7 months ago)
- Topics: api, api-documentation, openapi, openapi3, swagger, swagger-ui
- Language: JavaScript
- Size: 2.6 MB
- Stars: 91
- Watchers: 8
- Forks: 9
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OpenAPI 3 viewer
This service is designed to easily browse and test a REST API described with the [OpenAPI 3.0 Specification](https://github.com/OAI/OpenAPI-Specification) (fka Swagger Specification). This service mainly uses [vue-openapi](https://github.com/koumoul-dev/vue-openapi) component. It also provides a simple nodeJS backend for proxy purpose.
See it in action :
* https://koumoul.com/openapi-viewer/
## Sponsors
| | Click [here to support the development of this project](https://github.com/sponsors/koumoul-dev). |
|-|-|
| [
](https://koumoul.com) | [Koumoul](https://koumoul.com) develops the Data Fair ecosystem and hosts it as an online service. |
| [
](https://dawizz.fr) | [Dawizz](https://dawizz.fr) uses the Data Fair ecosystem inside its platform and supports its development. |
## Install
Clone this project and install dependencies with `npm install` or `yarn` then :
```
npm run dev
```
## Launch the service with Docker
A Docker image is publicly available. Run the following command :
```
docker run -p 8080:8080 ghcr.io/data-fair/openapi-viewer
```
and go to this [page](http://localhost:8080/)
## Query parameters
You can use the followings query parameters to prefill viewer
* **url** : The location of the API documentation file to load, in OpenAPI v3 JSON format.
* **proxy** : true or false if you want to fetch API documentation file using this service backend as a proxy. Defaults to false.
Can be usefull if the API description can't be reached with CORS headers. Do not use the proxy if you want to access an API description located on *localhost*.
* **headers** : URI encoded JSON dictionnary of headers that will be used to prefill parameters if they match. Can be usefull to prefill *x-api-key* or *authorization* headers.
* **query-params** : URI encoded JSON dictionnary of query parameters that will be used to prefill parameters if they match. Can be usefull to prefill an *organizationId* parameter in a multi-tenant application.
* **hide-toolbar** : true or false of you want to hide toolbar. This can be usefull for iframe integration. Defaults to false.