Effettuare il checkout di questa tecnologia "How to Design a Good API and Why it Matters". Copre alcuni punti importanti ed è indipendente dalla lingua.
Le diapositive per la presentazione sopra sono disponibili here.
Alcuni punti che realmente risonanza con me:
- Se si programma, si sono un designer API
- buon codice è modulare ogni modulo ha un'API
- Difficile uso improprio
- Scrivere più plug-in prima del rilascio
- Facile da leggere
- codice dovrebbe leggere come prosa
Per eccellenti esempi di grandi API, vorrei suggerire di dare un'occhiata a queste API (è un wiki comunità quindi per favore sentitevi liberi di aggiungere):
per contrastare Crapis dalle buone API, vedono questo esempio comune di aver letto tutto lin es da un file e stampandoli. (Java):
BufferedReader reader = new BufferedReader(new FileReader("filePath"));
String line = null;
while ((line = reader.readLine()) != null) {
System.out.println(line);
}
ho fatto lima IO con Java in tante occasioni e ho ancora di ricercare come fare File IO ogni volta, e questo è un modo conciso di fare le cose, per davvero.
vs (Rubino)
file = File.open("filePath", "r");
puts file.readlines
Un altro esempio da JavaScript. Inserire e rimuovere elementi da una posizione specifica in una matrice è qualcosa che si suppone sia un'attività comune.
Ecco come si può fare:
// insert element at index
someArray.splice(index, 0, element);
// remove element at index
someArray.splice(index, 1);
Ora è impressionante che i progettisti hanno fatto un lavoro impressionante a riusabilità del codice, ma non posso disturbare apertura w3schools.com ogni volta che ho bisogno di fare Questo. Quindi, questi semplici wrapper vengono inclusi come estensioni fondamentali per Array in tutti i miei progetti:
Array.prototype.insertAt = function(element, index) {
this.splice(index, 0, element);
}
Array.prototype.removeAt = function(index) {
this.splice(index, 1);
}
Nota: Non si tratta di codice più corto, ma il codice che è più semplice, più facile da ricordare, leggibile, e coerente, tra l'altro cose.
Vedi anche correlata domanda - How do you define a good or bad API?
Di cosa stiamo parlando? web apis? Apis sul lato server? – Pierreten
troppo aperto. Anche la lingua può aiutare (in modo da sfruttare le sue funzioni) – Earlz
Penso che il discorso di oggi da Google IO (Come le API di Google costruiscono) avrà una certa rilevanza qui, anche se non è ancora su Youtube - (http://code.google.com /events/io/2010/sessions/how-google-builds-apis.html). – Anurag