API Best Practices

I mentioned at the F2F that I would get some information regarding API best practices.   Here is a list (much thanks to Dom for his help):

* Marcos' guide (high level advice) :  https://wiki.mozilla.org/WebAPI/DesignGuidelines

* the TAG's usage of promises guide:  http://www.w3.org/2001/tag/doc/promises-guide

* Robin's Web API Design Cookbook (but last updated in 2012) http://www.w3.org/TR/api-design/

* Mike West's Security and Privacy self review questionnaire https://mikewest.github.io/spec-questionnaire/security-privacy/

* ReSpec guide: https://www.w3.org/respec/guide.html

* WebIDL examples: https://www.w3.org/respec/examples/webidl.html

if there are other useful materials, please share on the list.


regards, Frederick

Frederick Hirsch
Co-Chair, W3C Web Annotation WG


Received on Thursday, 7 May 2015 15:27:38 UTC