https://github.com/optum/kong-spec-expose
Plugin to expose the specification/contract of auth protected API services fronted by the Kong gateway
https://github.com/optum/kong-spec-expose
api-gateway kong optum
Last synced: about 1 year ago
JSON representation
Plugin to expose the specification/contract of auth protected API services fronted by the Kong gateway
- Host: GitHub
- URL: https://github.com/optum/kong-spec-expose
- Owner: Optum
- License: apache-2.0
- Created: 2018-06-01T15:09:30.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2021-08-04T14:30:29.000Z (almost 5 years ago)
- Last Synced: 2025-04-14T15:22:01.090Z (about 1 year ago)
- Topics: api-gateway, kong, optum
- Language: Lua
- Homepage:
- Size: 1.42 MB
- Stars: 5
- Watchers: 10
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Kong Spec Expose Plugin
## Overview
This plugin will expose the specification of auth protected API services fronted by the Kong gateway.
In short, API Providers need a means of exposing the specification of their services while maintaining authentication on the service itself, we do so by:
1. Plugin enables Kong users to specify the endpoint of their API specification.
2. Plugin will validate the Proxy request is GET method, and will validate the proxy request ends with "/specz". If these two requirements are met, the endpoint will return the specification documentation of the API Service with Content-Type header identical to what the API specification exposes.
## Supported Kong Releases
Kong >= 1.x
## Installation
Recommended:
```
$ luarocks install kong-spec-expose
```
Other:
```
$ git clone https://github.com/Optum/kong-spec-expose.git /path/to/kong/plugins/kong-spec-expose
$ cd /path/to/kong/plugins/kong-spec-expose
$ luarocks make *.rockspec
```
## Maintainers
[jeremyjpj0916](https://github.com/jeremyjpj0916)
[rsbrisci](https://github.com/rsbrisci)
Feel free to open issues, or refer to our [Contribution Guidelines](https://github.com/Optum/kong-spec-expose/blob/master/CONTRIBUTING.md) if you have any questions.