Project

amy

0.0
No commit activity in last 3 years
No release in over 3 years
amypurbon/amyHomepageDocumentationSource CodeBug TrackerWiki
Amy helps us to get a nice web docs, rdoc alike, of our REST API, that we can use as a main reference for users.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
11,066
Stars
1
Forks
0
Watchers
1
 Releases
Current version
0.3.3
Total releases
3
First release
2014-01-28
Latest release
2014-02-07
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2014-03-18
Reverse Dependencies
0

 Dependencies

Development

bundler
>= 0
jeweler
~> 1.8.3
rdoc
~> 3.12
rspec
>= 0
shoulda
>= 0
uglifier
>= 0

Runtime

json
>= 0
maruku
>= 0
 Project Readme

Amy

image

Gem Version

Build Status

Amy aims to be a documentation engine, something alike rdoc, but for REST APIs. With the motivation in mind to solve this situation, that has not much of options, specially in the ruby world.

With two mode of work, Amy can:

  • Scrap a list of documentation files.
  • Scrap your source code looking for special comments. Currently just works for sinatra

and use this info to compose a nice website with your API docs.

At the documentation website you will be able to see the resources aggregated per each url pattern, and within them see each method, in a very REST way. In some cases, for the GET, HEAD and OPTIONS methods you will be able to run them and analise the output.

I want to use it!

First of all, you've to understand this is in very pre alpha status, so everything can change in the near feature. But if you are still a brave man, you can take a look at examples directory to see who to run this gem.

If you've a nice feature in mind, please submit a pull request, every contribution is wellcome.

To create the documentation website you've to run:

  • amy [directory with the definitions]

There is an option to create a .amy file in your main directory where you'll be able to tune a few options for the engine. Take a look at .amy for an example.

TODO:

Next, and preatty obvious thing, is to write a decent documentation. I've in mind also to extend the source code parsing capabilities to include:

  • A better content management skills.
  • Support for more web frameworks and programming languages.

and I'm sure many others will popup.

Contributing to Amy

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
  • Fork the project.
  • Start a feature/bugfix branch.
  • Commit and push until you are happy with your contribution.
  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright

Copyright (c) 2013-2014 Pere Urbon-Bayes. See LICENSE.txt for further details.