Лучшие практики при разработке API

Question

Я разрабатываю внутренний API для системы, которую я пишу. Каковы некоторые передовые практики в разработке API?

Answer 1

Примеры приведены на Java, но подсказки применимы к любому языку.

Как разработать хороший API и почему это важно

Answer 2

Просто помните, что API - это пользовательский интерфейс . Я стараюсь сосредоточиться на

• делает одну вещь хорошо,
• поддержание полезного отношения мощности к весу,
• избегая загадочных имен,
• явное указание поведения с помощью тестов и эффективной документации

Answer 3

Test Driven Development.

TDD проинформирует ваш дизайн, потому что он побуждает вас задавать вопросы типа «что мне нужно сделать» и облегчает вам уверенный рефакторинг по ходу делачерез ваши ревизии.Это также побуждает делать вещи максимально простыми, что всегда хорошо.