Помогите API

[BeYkeR]

На деве я видел много API плагинов, и у меня появился вопрос - Как сделать свой API ?

 

[ptnk]

На деве я видел много API плагинов, и у меня появился вопрос - Как сделать свой API ?

I Без рефлекции

1 Продумать интерфейс плагина
2 Закомментить публичный свойства классов и сами классов
3 Сгенерировать javadoc под это дело
Теперь каждый желающий без декомпиляции, подключив к проекту jar, сможет юзать плагин, а документация в комплекте.
II Рефлексия
1 Продумать интерфейс плагина
2 Для каждого класса создать свой абтрактный класс или интерфейс с нужными свойствами класса и их описанием
3 Выложить этот набор абтсрактных классов и\или интерфейсов в архиве
Теперь каждый жюелающий без декомпиляции, не подключаяя к проекту jar может юзать твои функции, зная имена классов и свойств, используя рефлекцию.

 

[fromgate]

Собственно первый вариант очень прост. Грубо говоря, создавая плагин имей в виду, что любая переменная или любой метод объявленный как public может быть использован другими разработчиками, которые решат "подцепиться" к твоему плагину и использовать его в качестве API. Т.е. любой плагин уже сам по себе API.
С другой стороны если ты делаешь действительно API, то просто необходимо учесть возможность того, что твои функции будут время от времени меняться, но API должно быть максимально неизменным от версии к версии. Чтобы плагины написанные под одну версию, сохраняли свою работоспособность и с последующими версиями твоего плагина.