Я разрабатываю внутренний API для системы, которую я пишу. Каковы некоторые лучшие практики API Design, о которых нужно думать?Рекомендации по разработке API
ответ
Испытание развития.
TDD проинформирует вас о своем дизайне, потому что он предлагает вам задать такие вопросы, как «что мне нужно, чтобы это сделать», и это упростит вам рефакторинг с уверенностью, когда вы переходите через свои исправления. Он также поощряет сделать вещи максимально простыми, что всегда хорошо.
Просто помните, что API - это пользовательский интерфейс. Я стараюсь сосредоточиться на
- делать одно дело хорошо,
- поддержание полезного соотношение мощности к весу,
- избежать непонятных имен и
- явного указания поведения с помощью тестов и эффективной документации
Вы имеете в виду интерфейс для разработчиков? * Приложение * Программирование Интерфейсы напрямую не используются конечным пользователем. –
Приложения-программисты тоже люди :) Когда они используют интерфейс прикладного программирования, они являются «пользователями» этого программного интерфейса. Имена, документация и минимизация доступа очень важны при разработке API. –
+1 к стойке. Термин UI может быть перегружен, но намерение ясно. У всех есть пользователи - микропроцессоры, языки программирования, фреймворки, библиотеки; независимо от того, какое профессиональное имя мы предоставляем этим пользователям. – Anurag
Примеры приведены на Java, но подсказки применимы к любому языку.
- 1. Рекомендации по разработке API на основе Websocket
- 2. Рекомендации по разработке планшета
- 3. Рекомендации по разработке Android
- 4. Рекомендации по разработке командлетов Powershell
- 5. Рекомендации по разработке SharePoint 2007
- 6. Рекомендации по разработке 3 уровня
- 7. Рекомендации по разработке/отладке Android
- 8. Рекомендации по итеративной разработке представлений
- 9. Рекомендации по разработке дизайна Azure
- 10. Рекомендации по разработке документов Sweave
- 11. Рекомендации по разработке кода Android
- 12. Рекомендации по разработке iOS-игры
- 13. Рекомендации по разработке приложений для Twitter?
- 14. Рекомендации по разработке веб-разработки 3D-игр
- 15. Рекомендации по разработке кода, подходящего для рефакторинга
- 16. Как реализовать эти рекомендации по разработке компонентов
- 17. Рекомендации по разработке приложений для мобильных телефонов
- 18. Рекомендации по разработке долговременного ресурсоемкого веб-сервиса
- 19. Рекомендации по разработке схемы схемы кода купона
- 20. Рекомендации по разработке передовых совместимых протоколов связи?
- 21. Хорошие рекомендации/советы по разработке систем правил?
- 22. нужны рекомендации по разработке базы данных
- 23. Рекомендации по разработке баз данных с адресами
- 24. рекомендации по подготовке к разработке Android
- 25. Рекомендации по разработке GWT и CSS
- 26. Рекомендации по распределенной разработке в PHP
- 27. Рекомендации по разработке среды разработки PHP
- 28. Рекомендации по разработке «кросс-платформенных» с Qt
- 29. Нужны предложения по разработке рекомендации художника
- 30. Рекомендации по разработке набора зависимых пакетов R
Anachronistic? Как в будущем? :) Я поддержал его, хотя я считаю, что только TDD не означает рецепт успеха. Опыт необходим, но TDD может многое помочь в разработке API, потому что вы вынуждены использовать этот API. Еще одна вещь, которую я хотел бы сделать, - это TDD приложение, которое использует этот API. –
@mike, это слово, я не думаю, что это означает, что вы это значит;) – hvgotcodes
@ Ionut, нет уверенного пути для успеха. Но TDD может помочь только по-разному. – hvgotcodes