Add cookbook-style API documentation

hbz / lobid

Linking Open Bibliographic Data

https://lobid.org/

Eclipse Public License 2.0

16 stars 4 forks source link

Add cookbook-style API documentation #3

Closed fsteeg closed 5 years ago

fsteeg commented 10 years ago

Provide detailed, step-by-step instructions on how to use the lobid API for an app:

Getting data from the API, with HTTP requests
Processing the short and ids JSON format for autocomplete
Processing the full JSON format, get data from specific fields

Provide sample code and projects implemented in Java (server) and JavaScript (client).

acka47 commented 10 years ago

@fsteeg We probably should postpone this to after switching to API v2, shouldn't we? Propose moving this to the backlog, then.

acka47 commented 10 years ago

We should consider using Hydra for API documentation, see e.g. the last 13 minutes of a presentation by Markus Lanthaler: http://youtu.be/fJCtaNRxg9M?t=20m24s.

acka47 commented 5 years ago

WOn't fix/partly fixed. Closing.