Как использовать документацию по API

Люди обычно говорят, что используют документацию и код API.

Я относительно неплохо разбираюсь в языке JAVA, то есть могу писать простые программы. Недавно для проекта, над которым я работаю, меня попросили поработать над инструментом SOAPUI, и я читаю API SOAPUI для написания кода в Groovy. Делая это, я получил этот вопрос.

Как начать использовать документацию API (для любого языка/вещи)? Допустим, я хочу начать использовать API Google Map или API разработчика Yahoo.

Существуют ли какие-либо структурированные способы чтения и понимания API? Какие классы использовать в первую очередь или как вызывать или использовать различные методы.

Что нужно сделать, прежде чем читать конкретный API, и как можно научиться создавать вещи, читая и понимая API, и начинать что-то строить?

Какими навыками нужно обладать для этого? Как развить такие навыки.


java api soapui
person karthi    schedule 17.09.2010    source источник

Ответы (4)


arrow_upward
4
arrow_downward

Я предлагаю вам начать с руководств и примера кода. На самом деле документация по API — это своего рода справочная информация.

person Adeel Ansari    schedule 17.09.2010

arrow_upward
1
arrow_downward

Когда я начинаю использовать новый инструмент/API, я всегда сначала читаю документацию, чтобы получить общее представление о том, что это такое/что он делает/как он работает. Документация обычно указывает на учебник, что я и делаю дальше. Затем я попытаюсь создать свое собственное действительно простое тестовое приложение, которое использует API довольно тривиальным способом.

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

person Qwerky    schedule 17.09.2010
comment
Это может быть применимо к языку программирования, где у вас будет некоторая база, как насчет нового инструмента или API Google MAP? - person karthi; 17.09.2010
comment
@karthi Я бы сказал, что этот подход более актуален для нового API, чем для нового языка программирования. Чтение API сразу вызовет путаницу. Информации слишком много, и без контекста ее трудно понять. - person Qwerky; 17.09.2010

arrow_upward
1
arrow_downward

  1. Полностью прочитайте API и уясните требования для каждого вызова метода. Например. Некоторые вызовы являются методами GET/POST. Поймите, какие параметры им требуются и какой ответ они возвращают.
  2. Поиграйте с API. Обычно есть система Sandbox, где вы можете играть с вызовами API и т. д.
  3. Напишите свой собственный код (как вам нравится) и играйте с ним, пока не поймете поток API.

Как только вы освоитесь, разработайте архитектуру, которая лучше всего подходит для API. По сути, чтение документации необходимо для понимания API.

Надеюсь это поможет.

person Buhake Sindi    schedule 17.09.2010
comment
Когда я начинаю использовать API, я теряюсь из-за того, как КЛАССЫ, МЕТОДЫ и ИНТЕРФЕЙСЫ связаны друг с другом. Как этого избежать? - person karthi; 17.09.2010
comment
Я не совсем понимаю вас, пожалуйста, уточните. - person Buhake Sindi; 17.09.2010

arrow_upward
0
arrow_downward

Недавно я тоже пытался их выяснить, в основном пытаясь отследить, к каким объектам у меня был доступ, пока я писал тестовые сценарии для тестовых случаев. У меня возникли проблемы с определением типов журнала, контекста, testStep и т. д. по отношению к API. Для меня сообщения об ошибках были золотой жилой. Когда я пробовал что-то не так, он четко указывал тип объекта и указывал мне правильное направление в API.

Еще одна вещь, которая поставила меня в тупик, которая может оказаться полезной для тех, кто недостаточно внимательно читал Groovy для начала (как я), заключается в том, что Groovy предоставляет все свойства без необходимости вызывать геттер или сеттер. Таким образом, myObj.myProp = 5 соответствует методу setMyProp(5) в API. Простые вещи, но я почесал голову, потому что некоторые из них были новичками в этом!

person Dustin    schedule 21.09.2010