Project

angband

0.0
No commit activity in last 3 years
No release in over 3 years
There's a lot of open issues
Self-Documenting APIs for Rack applications
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Runtime

 Project Readme

Angband

Rack middleware that renders the Gherkin features of your application.

Configuration

  1. Specify the applicable feature files:

    require 'angband/documentation'
    
    use Angband::Documentation do |docs|
      docs.configure Dir['features/**/*.feature']
    end
  2. Annotate your features with the URI path to which they apply:

    @/api/status
    Feature: Status of the API

    Use regular expressions to match variable paths:

    @/api/message/\d+
    Feature: Read a single message
  3. Configure your application to respond successfully to an HTTP OPTIONS request.

While this middleware sets the response Content-Type and body, any other headers should be added by the application, e.g. the Allow header.