search

g0v / api.ly

api.ly.g0v.tw - ly api endpoint
14 stars 6 forks source link

Documentation #32

Closed jimyhuang closed 10 years ago

jimyhuang commented 10 years ago

Plan to use http://apiblueprint.org/ to write markdown, parse by http://apiary.io/ .

Reference list for writing api:

jimyhuang commented 10 years ago

for now, we just add https://github.com/g0v/api.ly/blob/master/apiary.apib directly from "https://app.apiary.io/twly/editor" . Everyone have permission to commit g0v/api.ly/apiary.apib will sync to https://app.apiary.io/twly directly.

jimyhuang commented 10 years ago

"Try it" on the http://docs.twly.apiary.io/ have problem. That's because the try it feature actually not call real api, just display sample response written in documentation (apiary.apib).

For now, I just write api link in the description directly.

Will not use the "Try it" feature until apiary.io add switch to real api feature later.

clkao commented 10 years ago

@jimyhuang++