Как предоставить API для нашей системы

Question

У меня не было большого опыта работы с веб-службами или API.

У нас есть сайт, основанный на Oracle-> Sun App Server-> Java-> Struts2 framework. У нас есть требование предоставить API для нашей системы. Этот API будет использоваться другими системами за пределами нашей системы. API - это просто простой SP, который мы имеем в нашей базе данных. Другая система не хочет подключаться к нашей БД, чтобы получить доступ к СП, но вместо этого и API в качестве «webservice»

Может ли сообщество пролить свет на то, как это сделать? Будет ли API помещен на наш веб-сервер? заключается в том, как к ней подключается другая система? И как сделать создание публичного API?

Answer 1

Если вы используете сервер приложений Sun, довольно просто сделать EJB открытым как веб-сервис с тегом @WebService, а затем включить EJB в Хранилище и вернуть данные. Сервер приложений предоставляет вам инструменты для публикации WSDL, которые они будут использовать, чтобы знать, как назвать вас API.

Это, как говорится, то, что звучит легко на высоте 50 000 футов, является настоящей болью, чтобы справиться со всеми деталями. Во-первых, как насчет безопасности? Во-вторых, действительно нужны WebServices или есть более понятный механизм связи, такой как (как минимум) REST, если не какая-то простая передача сервлетов. И самое сложное: в каком формате вы вернете этот набор результатов?

В любом случае, вы можете иметь дело с политическим футболом здесь («что, вы не знаете, как делать веб-службы, все это знают и т. Д.»), Поэтому это может быть немного сложно исследовать требования. Хорошей новостью является то, что публикация веб-сервиса довольно тривиальна в последней Java EE (намного проще, чем потреблять). Плохая новость заключается в том, что детали будут убийцей. Например, опытные разработчики веб-сервисов тратят часы на проблемы с пространством имен.

Answer 2

Некоторые вещи, которые вы должны будете думать о том, являются:

• SOAP против REST (Why would one use REST instead of SOAP based services?)
• Как вы справляетесь аутентификации?
• Нужно ли масштабировать?

Возможно, вы захотите взглянуть на https://jersey.dev.java.net/.

Было бы также полезно посмотреть, как это делает другая компания, отметьте http://www.flickr.com/services/api/ для некоторых идей.

Answer 3

Мыло или отдых или .. является одной из сторон медали и зависит от того, чего хотят клиенты. Другая (более) важная вещь - сама конструкция api. Должен ли он быть апатридом или государством. Клиенты находятся совместно на одной виртуальной машине (Appserver) или удаленной в той же локальной сети или даже в Wan. Как только связь проходит по проводу, она замедляется из-за сериализации. Поэтому вы хотите, чтобы методы API получали большие (но не слишком большие) фрагменты данных за раз.

Или, другими словами, на ваш вопрос нельзя ответить, не зная намного больше о том, чего вы хотите и что нужно делать.