https://github.com/rafasf/gh-openapi-preview
Preview OpenAPI spec in GitHub Pull Requests
https://github.com/rafasf/gh-openapi-preview
chrome-extension openapi
Last synced: 2 months ago
JSON representation
Preview OpenAPI spec in GitHub Pull Requests
- Host: GitHub
- URL: https://github.com/rafasf/gh-openapi-preview
- Owner: rafasf
- License: mit
- Created: 2019-04-25T19:00:38.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2020-01-31T14:17:42.000Z (over 6 years ago)
- Last Synced: 2025-03-18T06:33:48.976Z (over 1 year ago)
- Topics: chrome-extension, openapi
- Language: JavaScript
- Size: 429 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub OpenAPI Preview
If you are browsing API specs in a GitHub repository or looking at a pull
request which contains one, you will be get a link to preview it through ReDoc
in a new tab. :smile:
## What does it look for?
Files named `openapi.{yaml,yml}`, `api.{yaml,yml}` and `swagger.{yaml.yml}`.
## Usage
1. Clone the repository
2. Enable "developer mode" in Chrome Extensions
3. Load unpacked, and select this directory
## Be Aware
After switching tabs in a pull request, you will need to refresh the page for
the extension to identify the files present.
## What do you see?
After installing the extension, go to a [pull request that has a OpenAPI spec](https://github.com/rafasf/gh-openapi-preview/pull/1/files) and you will see the following:
