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

Question

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

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

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

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

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

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

Answer 1

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

Answer 2

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

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

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

Answer 3

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

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

Answer 4

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

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