Frisk tries to fill the communication gap between developers that develop APIs and those who write code to consume those APIs. With Frisk, you can tell which APIs are red(broken), how to construct correct API requests and what the expected responses are.
Frisk will let you record API requests and responses and create runnable examples out of those which become your living documentation in development environment.
To sum it up, Frisk is your
- API doc
- API health check
- API explorer
gem install frisk
This gives you the executable frisk
, which you can run to start the app.
- Clone the repo
bundle install
- Write code and tests
bundle exec rake
to run RSpec and Karma JS test runner