As Mark mentions on his summary page, the best place for that kind of information is our CTO's "Inside the Engine" series (8 parts).
https://blog.algolia.com/inside-the-algolia-engine-part-1-in...
178 karma · joined June 28, 2011
As Mark mentions on his summary page, the best place for that kind of information is our CTO's "Inside the Engine" series (8 parts).
https://blog.algolia.com/inside-the-algolia-engine-part-1-in...
Security is super important, but we can provide encryption-at-rest and have a secured API key [1] feature that allows you to segment your user base.
[1] - https://www.algolia.com/doc/guides/security/api-keys/#secure...
Also, plugging: Swagger support in just a few weeks. And we can currently auto generate endpoint reference docs from your source code using a commenting standard similar to javadoc.
We get all sorts of excited by good API documentation. Weird, right? Apparently not, based on this thread. :D
ReadMe.io currently focuses more on the "front end" of the API. We can ingest in-line comments made with the apiDoc.js [1] standard, and then use that description to build an API explorer and reference docs automatically. We like apiDoc because of how concise the comments are, and because they are kept very close to the code (no extra files to maintain). It's not as common as some of the other standards mentioned here, but it's — by far — the fastest and most straightforward way to describe an API.
Edit: this is how it's implemented within ReadMe.io: http://readme-sync.readme.io/v1.0/docs