search

centraldedados / datacentral

Tools for generating portable data portals
58 stars 9 forks source link

add swagger for the api description? #15

Open seralf opened 9 years ago

seralf commented 9 years ago

i wonder if the current format for the api.json is a standard format, compatibile with CKAN. If not, what about using the javascript, "static" version of the swagger api, instead? http://swagger.io/

it could give access to a simple HTML documentation without much effort

rlafuente commented 9 years ago

That's a good question. I think @metaodi might have some helpful insights here, since he took care of the API implementation.

metaodi commented 9 years ago

I like the idea a lot, I'll look into this.

The current API is nothing else but the concatenated datapackages of all the datasets on the portal. Because we only have static files there are not very many possibilities. I try to find a description so that swagger can be used. Ideally we'll have a separate route for each dataset.

seralf commented 9 years ago

yes and they recently put up an online editor to help produce the json description which can be consumed by the html front (the other options is for the server side annotations, if/when you have one, but it's not the case here :-)

2014-11-25 20:13 GMT+01:00 Stefan Oderbolz notifications@github.com:

I like the idea a lot, I'll look into this.

The current API is nothing else but the concatenated datapackages http://dataprotocols.org/data-packages/ of all the datasets on the portal. Because we only have static files there are not very many possibilities. I try to find a description so that swagger can be used. Ideally we'll have a separate route for each dataset.

— Reply to this email directly or view it on GitHub https://github.com/centraldedados/datacentral/issues/15#issuecomment-64454099 .