Najlepsze praktyki i wytyczne dotyczące projektowania API [zamknięty]

Jako ktoś, kto musi konsumować Tony API...

Napisz swoje API w spójny sposób:

1. Spójne nazewnictwo w samym API. Używaj czasowników, rzeczowników, słów kluczowych w dokładnie tym samym stylu.

2. Zgodny z docelowym środowiskiem, w którym będzie używany. Jeśli. NET, zapoznaj się z wytycznymi Microsoftu dotyczącymi nazewnictwa.

3. Spójne koncepcje. Wzór fabryczny? Wzór budowniczego? Metody statyczne? Interfejsy? Wybierz jedną i trzymaj się to. Naprawdę. Nie ma czegoś takiego jak mały wyjątek od reguły. Będzie wystawać jak wielki ból kciuka. Więcej niż 1 wyjątek? Twoje API jest coraz bardziej Amatorskie.

Tu jest jeszcze jeden: specyficzność.

1. Klasy bazowe, które mogę zaimplementować, jeśli zdecydujesz się je dostarczyć, powinny mieć kilka dobrze zdefiniowanych funkcji do zaimplementowania. Nie mów mi, że "GetData () "zwraca" object []", a następnie oczekuj, że go zaimplementuję, dowiedz się, dlaczego muszę go rzucić do ciągu znaków [], a następnie debugować, dlaczego jest wywoływany 20 razy. Znacznie lepiej jest mieć DataPoint [] GetChartData (), string[] GetLabelData (), itd. i pozwól mi wybrać, które z nich powinienem wdrożyć.

2. Proszę się nie wygłupiać-długie z nazwami: PostRenderColorWheelModifyHSVBasehandler. Często można refaktorować super-specyficzne rzeczy w bardziej ogólne nazwy + parametry.

3. Parametry łańcucha są Nie-Nie! Użyj wyliczeń. Nie chcę używać takiego opiekuna jak

   PostRenderHandler("ColorWheel", "HSV", someDelegate);

Wolałbym enum, które mogę zbadać:

PostRenderHandler(ModuleType.ColorWheel, Options.ColorWheelHSV, someDelegate);

Jest dobra prezentacja na ten temat od Joshua Bloch. Prezentacja wykorzystuje Javę, ale pomysły są niezależne od języka. inne źródło (pdf) dla szybkiego przeglądu.

To jest link od Microsoftu: http://msdn.microsoft.com/en-us/library/ms229042.aspx

Jest też ta książka: Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable. NET Libraries

Myślę, że twoje pytanie nie otrzyma odpowiedzi w takiej ilości miejsca z ilością informacji, które podajesz. Umieściłem kilka linków z wpisując "API design" w google, a na pierwszej stronie dostać te, które wyglądają ładnie dobry

Http://web.archive.org/web/20151229055009/http://lcsd05.cs.tamu.edu/slides/keynote.pdf

Http://www.artima.com/weblogs/viewpost.jsp?thread=142428

Http://web.archive.org/web/20090520234149/http://chaos.troll.no/~shausman/api-design/api-design.pdf