RUBY

api blueprint minitest rails

require 'json_matchers/minitest/assertions'
JsonMatchers.schema_root = 'test/support/schemas'
Minitest::Test.send(:include, JsonMatchers::Minitest::Assertions)

api blueprint minitest rails

$ bin/rails api:schemas
Generating api schemas from docs/api/documentation.md
yarn run v1.7.0
$ node_modules/.bin/apib2json --pretty -i docs/api/documentation.md -o test/support/schemas/schemas.json
Done in 0.31s.
Writing GET-Users-200
Writing POST-Users-201
Writing POST-Users-422
Schemas are ready at test/support/schemas

api blueprint minitest rails

$ bin/yarn add "https://github.com/mariochavez/apib2json.git#additional-metadata"

api blueprint minitest rails

namespace :api do
  desc 'Build API documentation'
  task :documentation do
    input_file = 'docs/api/documentation.md'
    output_file = 'public/documentation.html'
    system(" bin/yarn run aglio -i #{input_file}  -o #{output_file}")
  end
end

api blueprint minitest rails

$ bin/yarn add aglio

api blueprint minitest rails

$ bin/yarn run aglio -i docs/api/documentation.md -o public/documentation.html

api blueprint minitest rails

{
    "address" : {
        "street": "",
        "city": "",
        "state": ""
    }
}

api blueprint minitest rails

- address
    - street
    - city
    - state