https://github.com/seriousme/swaggerspy

Proxy to generate swagger spec from an existing API
https://github.com/seriousme/swaggerspy

Last synced: 7 days ago
JSON representation

Proxy to generate swagger spec from an existing API

• Host: GitHub
• URL: https://github.com/seriousme/swaggerspy
• Owner: seriousme
• Created: 2017-01-22T16:14:53.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-01-31T09:36:40.000Z (almost 8 years ago)
• Last Synced: 2024-10-19T11:28:53.626Z (3 months ago)
• Language: JavaScript
• Size: 20.5 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# swaggerSpy

HTTP proxy to generate swagger spec from an existing API

## How it works

1. Start swaggerSpy and point it to an existing API (e.g. swagger.io's petstore demo) 

2. Point an API client (e.g. a browser or a cmdline client) to the swaggerSpy proxy

3. Have the API client execute a number of actions

4. Point a browser to the swaggerSpy controller and see the generated Swagger specification

## Disclaimer

- swaggerSpy can't identify hidden information, e.g. if your path contains /pets/{petname} then swaggerSpy currently has no way to figure out that the last part is a variable.

- swaggerSpy is still experimental, if you find cases where you think spec generation could be improved please submit a pull request or raise an issue and attach the trace data whcih can be obtained via the help menu of the controller.