Re:How GitHub Uses GitHub to Document GitHub
by gjtorikian on Tuesday January 06, 2015 @06:50PM
(#8847952)
> Do you plan to write and update the JSON Schema by hand?
Currently, yes, unfortunately. ;____; We've talked about doing it in an intermediate format, like YAML, which is slightly less painful, but....ugh. Years ago I wrote a very badly-coded-but-essentially-functional tool called Panino, which converted Markdown-to-JSON: https://github.com/gjtorikian/panino-docs/tree/master/lib/pa....
I see that some people have picked up on that and ran along with it, too: https://github.com/apiaryio/mson. So there might be something there to explore.
2. I've never looked into either. I know Swagger is used by several companies, like Twitter, but API Doc is new to me.
Currently, yes, unfortunately. ;____; We've talked about doing it in an intermediate format, like YAML, which is slightly less painful, but....ugh. Years ago I wrote a very badly-coded-but-essentially-functional tool called Panino, which converted Markdown-to-JSON: https://github.com/gjtorikian/panino-docs/tree/master/lib/pa....
I see that some people have picked up on that and ran along with it, too: https://github.com/apiaryio/mson. So there might be something there to explore.
2. I've never looked into either. I know Swagger is used by several companies, like Twitter, but API Doc is new to me.