GitHub - eastmedia/web_services

Branches Tags

Name		Name	Last commit message	Last commit date
Latest commit History 19 Commits
bin		bin
examples		examples
lib		lib
spec		spec
.gitignore		.gitignore
Gemfile		Gemfile
Gemfile.lock		Gemfile.lock
README		README
web_service_documenter.gemspec		web_service_documenter.gemspec

Repository files navigation

Web Service Documenter is a way of automatically generating documentation
about your web services using YAML. It documents enpoint URL, parameters, description and
automatically shows output.

== Installation
  Clone this repository
  > gem build web_service_documentor.gemspec
  > gem install web_service_documentor-x.x.x.gem

== Usage

  web_service_documentor path/to/your/web_services.yml

== web_services.yml

  A file describing your web service end points.
  See examples/web_services.yml