search

xentek / hyperdrive

hypermedia state machine
https://rubygems.org/gems/hyperdrive
MIT License
5 stars 0 forks source link

CLI Interface for generating documents based on API resources #1

Closed jpark3000 closed 10 years ago

jpark3000 commented 10 years ago

A CLI interface for generating relatively simple markdown files documenting API resources. Implemented with Thor. Can take a single file or a directory and output a markdown file to a specified location (if not specified defaults to 'docs/doc.md').

jpark3000 commented 10 years ago

Refactors Hyperdrive::Docs to be more generalized and decoupled from the Hyperdrive API internals. Hyperdrive::Docs #list uses nested #each to iterate through params and filters without having to dip into the actual internals of a resources params/filters. As a result the formatting of the generated doc may not be the most ideal, but all the information for a resource is still presented in a logical manner.