This project is archived because the functionality has moved to AppMap OpenAPI.
How to use AppMap OpenAPI
appmap_swagger is a Ruby gem which provides a Rake task to generate Swagger 3 (aka OpenAPI) YAML from AppMap data.
It depends on an NPM package called @appland/appmap-swagger, which does most of the heavy lifting of converting AppMaps to Swagger.
To the NPM package, this gem adds:
- A Rake task - Normally configured as
appmap:swagger. - Rails integration - For example, default configuration of the application name.
- Swagger "diff" - Smart comparison of the current revision Swagger YAML to a base revision.
Visit the AppMap Swagger for Ruby reference page on appmap.io for a complete reference guide.
After checking out the repo, run bundle to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.
To release a new version, update the version number in version.rb, and then run bundle exec rake gem:release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/getappmap/appmap_swagger-ruby.
The gem is available as open source under the terms of the MIT License.