Table of Contents
- What is grape-swagger?
- Related Projects
- Compatibility
- Swagger-Spec
- Installation
- Usage
- Model Parsers
- Configure
- Routes Configuration
- Using Grape Entities
- Securing the Swagger UI
- Example
- Rake Tasks
What is grape-swagger?
The grape-swagger gem provides an autogenerated documentation for your Grape API. The generated documentation is Swagger-compliant, meaning it can easily be discovered in Swagger UI. You should be able to point the petstore demo to your API.
This screenshot is based on the Hussars sample app.
Related Projects
Compatibility
The following versions of grape, grape-entity and grape-swagger can currently be used together.
grape-swagger