Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Auto doc generation #4

Open
ozydingo opened this issue Oct 11, 2017 · 2 comments
Open

Auto doc generation #4

ozydingo opened this issue Oct 11, 2017 · 2 comments

Comments

@ozydingo
Copy link
Owner

Since we're all about making API docs easy, and since we have all the information we need, let's add a rake task or something similar that can automatically generate a boilerplate API doc for the given despecable controller actions.

First pass we can look through the code. But it'd be hella cool if we could define a new reader class that had different definitions of the integer, string, etc methods. We would need to load these ActionController subclasses carefully.

@ozydingo
Copy link
Owner Author

How do we distinguish between route and query params? Probably by parsing rake routes for symbols in the route.

@ozydingo
Copy link
Owner Author

On that note, parsing rake routes would be a great addition to this feature so we could auto-generate the full endpoints

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant