Разработка API

Question

[Максим]

Посоветуйте, что почитать (что-нибудь фундаментальное или популярное) по разработке API (технологии, правила, методики), как применительно к Java, так и в целом?

Answer 1

[jj_killer]

По теме, первое, что вспомнилось: REST API Design Rulebook, RESTful Java with Jax-RS, RESTful Web Services Cookbook.

Answer 2

[Lonkly]

>> как применительно к Java

Лучше Java не применять к веб разработке. А по теме: учите JavaScript, сейчас на нем все строят

Comments

[nochkin]

В начальном вопросе про веб разработку ничего не говорится.
Да и выражение «Лучше Java не применять к веб разработке» звучит очень уж спорно. Server-side на Java вполне активно используется в веб разработке.

[Lonkly]

я не говорю что оно не используется, просто вы спросили про АПИ, а 2 дня конфиругить сервер, и заниматься прочими ентерпрайз непотребностями в моем понимании не ок.
И да, джавабоги сразу же зашли и минуснули

[Mike Grigorieff]

Я не ДжаваБог, но простите вы действительно написали не компетентный ответ

[Lonkly]

А как можно ответить на вопрос: что мне почитать про разработку АПИ? Ни целей, ни критериев, ничего. Технологии — MVС. Правила? Методики? Для работы с чем? С моделью? Как делать контроллеры? Так везде ж все разное. А джаваскрипт не помешает :)

[jj_killer]

Джава тут ни при чем. API это вещь которую каждый может строить по своим предпочтениям, и единого варианта тут быть не может. И книг по API очень много, причем не завязанных на язык.

[zarincheg]

Причем тут MVC?)

[a_b]

dropwizard.codahale.com/

Answer 3

[Sergey Cherepanov]

Еще про REST — blog.apigee.com/detail/restful_api_design

Comments

[zarincheg]

Выше по теме уже написали насчет REST концепции. Думаю можно посмотреть и в сторону SOAP, хотя это более громоздкое решение. Но это что касается взаимодействий через http. А в общем случае это же просто интерфейс взаимодействия с системой, который должен быть описан в каком-либо формате и протокол для этого взаимодействия. То есть по сути вам нужно решить 2 основных вопроса: реализация логики API и способ коммуникации с внешним миром. Вы например можете написать некий класс, скажем MyCoolAPI, каждый метод которого будет обрабатывать соотв. запрос. И если клиенты для вашего API способны использовать этот класс непосредственно, то всё готово. Если клиентская технология не позволяет этого, тогда множество способов, от общения через сокеты до SOAP и REST. Это конечно совсем упрощенно. Хотя по-моему, при разработке внешнего интерфейса к системе усложнять ничего не нужно, это всего лишь интерфейс)

[wiz]

Не надо смотреть в сторону SOAP. Пользователи АПИ вас проклянут потом…

Answer 4

[anmipo]

Выступление Джошуа Блоха (автор «Effective Java», «Java Concurrency In Practice», работал в Google в роли Chief Java Architect): "How to design a good API and why it matters".

Answer 5

[afiskon]

Если речь о веб-апи — однозначно REST. Иначе — исходите из задачи и ваших потребностей. Например, если у вас есть база данных пользователей, напишите методы/функции getUserIdList(), getUserById(), и так далее. Объединяйте их в модули/классы в соответствии с функционалом. Скажем, пользователи должны быть отдельно от товаров. Помните об абстракции. Например, если вы вдруг решили кэшировать список id пользователей, интерфейс должен остаться прежним.

А вообще, думается, это приходит с опытом.