что такое sdk java

SDK и API: в чем разница?

Разработчики программного обеспечения пользуются основными инструментами: SDK и API. По сути, как SDK, так и API позволяют улучшить функционал приложений, не прибегая к большим усилиям.

Что такое SDK?

Аббревиатура SDK расшифровывается как software development kit. SDK, или devkit, — это набор средств для разработки ПО под определенную платформу. Он содержит компоновочные блоки, средства отладки, а зачастую фреймворк или группу библиотек кода, например набор подпрограмм для определенной операционной системы.

В стандартном SDK могут присутствовать как некоторые, так и все компоненты из списка ниже:

Как работает SDK

SDK предоставляет инструменты, которые способствуют ускорению и стандартизации разработки приложений.

Примеры использования SDK

SDK — неотъемлемая часть разработки мобильных приложений. SDK имеют множество областей применения:

Преимущества SDK

Что такое API?

Аббревиатура API расшифровывается как application programming interface (интерфейс программирования приложений). API — и как отдельное решение, и в составе SDK — облегчает обмен данными между двумя платформами и позволяет сторонним разработчикам использовать функционал проприетарного ПО.

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

Поскольку некоторые API предоставляют интерфейс напрямую, термины API и «интерфейс» иногда взаимозаменяемы.

Чтобы внести ясность, стоит отметить, что API может состоять из двух компонентов:

Что представляет вызов API с технической точки зрения:

Нужно ли выбирать между SDK и API?

Нет, ведь как сказано выше, SDK зачастую имеет по меньшей мере один API. Они выполняют разные функции, но могут работать и помогать вместе.

Следует иметь в виду, что с использованием API и SDK связаны некоторые сложности. Одна из них заключается в потенциальных уязвимостях. Другая сложность, относящаяся к SDK, — частота обновлений. Поэтому важно, чтобы команды DevOps держали вопрос информационной безопасности в поле зрения, а также следили за своевременным обновлением компонентов.

Оригинальный материал на английском языке доступен по ссылке.

Источник

Национальная библиотека им. Н. Э. Баумана
Bauman National Library

Персональные инструменты

Java Development Kit

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

Содержание

История

Компания Sun Microsystems активно развивала и обновляла JDK, почти каждый год выходили новые версии. В 1996 г. была выпущена первая версия — JDK 1.0, которая модифицировалась до версии с номером 1.0.2. В этой версии библиотека классов Java API содержала 8 пакетов. Весь набор JDK 1.0.2 поставлялся в упакованном виде в одном файле размером около 5 Мбайт, а после распаковки занимал на диске около 8 Мбайт.

В 1997 г. появилась версия JDK 1.1, последняя ее модификация, 1.1.8, выпущена в 1998 г. В этой версии было 23 пакета классов, занимала она 8,5 Мбайт в упакованном виде и около 30 Мбайт — в распакованном. В первых версиях JDK все пакеты библиотеки Java API были упакованы в один архивный файл classes.zip и вызывались непосредственно из этого архива, его не нужно было распаковывать. Затем набор инструментальных средств JDK был сильно переработан.

Версия JDK 1.2 вышла в декабре 1998 г. и содержала уже 57 пакетов классов. В архивном виде это файл размером почти 20 Мбайт и еще отдельный файл размером более 17 Мбайт с упакованной документацией. Полная версия располагается на 130 Мбайт дискового пространства, из них около 80 Мбайт занимает документация. Начиная с этой версии, все продукты технологии Java собственного производства компания Sun стала называть Java 2 Platform, Standard Edition, сокращенно J2SE, а в литературе утвердилось название Java 2. Кроме 57 пакетов классов, обязательных на любой платформе и получивших название Core API, в Java 2 JDK 1.2 входят еще дополнительные пакеты классов, называемые en:Standard Extension API.

В версии J2SE JDK 1.5.0, вышедшей в конце 2004 г., было уже под сотню пакетов, составляющих Core API (Application Programming Interface). В упакованном виде — это файл размером около 46 Мбайт и необязательный файл с упакованной документацией такого же размера. В это же время произошло очередное переименование технологии. Из версии убрали первую цифру и стали писать Java 2 Platform, Standard Edition 5.0, сокращенно J2SE 5.0 и JDK 5.0, хотя во внутрифирменной документации сохраняется название JDK 1.5.0. Последнее обновление J2SE 5.0, JDK 1.5.0_22, было выпущено 3 ноября 2009 года.

В шестой версии, вышедшей в начале 2007 г., из названия технологии убрали цифру 2 и стали писать Java Platform, Standard Edition 6, сокращенно — Java SE 6 и JDK 6. Впрочем, во внутрифирменной документации остается прежнее обозначение, например последнее на момент написания книги обновление обозначается JDK 1.6.0_26. Летом 2011 года появилась седьмая версия Java SE 7 и распространяется JDK 1.7.0.

Программы и классы, входящие в JDK

Набор программ и классов JDK содержит:

Версии

JDK имеет следующие версии:

Различие между JDK, SDK и ADK

Разница между JDK и JRE

«JDK» является Java Development Kit. То есть, это комплект JDK программного обеспечения, которое можно использовать для разработки Java Based программного обеспечения. «JRE» является Java Runtime Environment. То есть, en:JRE это реализация виртуальной машины Java, которая в действительности выполняет Java программы.

Источник

Различия между JDK и Java SDK

есть ли существенная разница между этими двумя терминами?. Я понимаю, что JDK означает Java Development Kit, который является подмножеством SDK (Software Development Kit). Но указание Java SDK должно означать то же самое, что и JDK.

15 ответов

JDK является подмножеством того, что свободно определяется как набор для разработки программного обеспечения (SDK) в общем смысле. В описаниях, которые сопровождают их последние выпуски для Java SE, EE и ME, Sun признают, что в соответствии с их терминологией JDK формирует подмножество SDK, которое отвечает за написание и запуск программ Java. Остальная часть SDK состоит из дополнительного программного обеспечения, такого как приложение Серверы, Отладчики и документация.

«дополнительное программное обеспечение», похоже, Glassfish, MySQL и NetBeans. на этой странице дает сравнение различных пакетов, которые вы можете получить для Java EE SDK.

Да, есть разница между SDK и JDK. Большинство людей забывают, что платформа Java используется не только для разработки программ на языке Java. JVM также поддерживает некоторые другие языки. Таким образом, чтобы было ясно, SDK-это общий пакет программного обеспечения, который поддерживает создание программного обеспечения на различных языках, таких как Clojure, Groovy, Scala, JRuby и другие. JDK-это конкретный пакет для разработки программного обеспечения на языке Java, содержащий весь JAVA standard API для этого. (Я надеюсь Я объяснил это хорошо, так как я на самом деле не говорю по-английски)

JDK-это SDK для Java.

SDK означает «набор для разработки программного обеспечения», инструменты разработчиков, которые позволяют писать код с большей легкостью, эффективностью и эффективностью. SDKs приходят для различных языков. Они предоставляют множество API (интерфейсов прикладного программирования), что упрощает работу программиста.

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

SDK для Java называется JDK, Java Development Kit. Итак, говоря SDK для Java, вы фактически ссылаясь на JDK.

Java является независимым от платформы языком. JRE запускает JVM, виртуальную машину Java, которая позволяет запускать программное обеспечение на любой платформе, для которой доступна JVM.

взято из установщика Java EE 6 SDK, показывает, что SDK 6 содержит помимо JDK:

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

JDK (Java Development Kit) является SDK (Software Dev Kit).

Он используется для создания программного обеспечения/приложений на Java и, конечно же, он включает JRE (Java Runtime Edition) для выполнения этого программного обеспечения. Если вы просто хотите выполнить Java-приложение, загрузите только JRE.

кстати, Java EE (Enterprise Edition) содержит библиотеки пакетов классов «с методами (функциями)» для создания приложений для веб-среды и Java ME (Micro Edition) для мобильных устройств устройства. Если вас это интересует (Java ME), я бы рекомендовал взглянуть на Android DevKit и API Google.

Sun просто любит менять названия вещей без видимой причины. Посмотрите на три различные схемы нумерации для SunOS / Solaris или две схемы нумерации для Java. Является ли Java 1.6, Java 2 версии 6 или Java 6?

Итак, почему существуют эти две разные ссылки ( SDK и JDK), чтобы загрузить их?

нет никакой разницы между JDK и Java SDK. Оба они означают одно и то же. Я думаю, что это было PR-решение на Sun, чтобы перейти от JDK к Java SDK. Я думаю, что сейчас он вернулся к JDK.

с моей точки зрения, нет никакой разницы между JDK и SDK в java. Мы можем найти все инструменты разработки, а также средства в обоих из них. это просто псевдоним, предоставленный sun.

лучший пример для этого вопроса, SDK-Software Development Kit-Ex: Netbeans JDK-Java Development Kit.(Это компилятор Java). Без JDK мы не можем запускать java-программы в SDK.

JDK поставляется с набором инструментов, которые используются для разработки и запуска программ Java,

appletviewer (для просмотра Java-апплетов)

javac (компилятор Java)

java (интерпретатор Java)

javap (Java disassembler)

javah (для заголовка C файлы)

javadoc (для создания HTML-документов)

в то время как SDK поставляется со многими другими инструментами, включая инструменты, доступные в JDKs.

нет никакой разницы.

Я думаю, что jdk имеет определенные функции, которые могут быть использованы вместе с конкретной структурой. Назовем это SDK в целом.

Как Android или Blackberry оба используют java вместе со своей структурой.

Edit: хотя на данный момент это кажется неправильным. Sun находятся в процессе opensourcing JVM (возможно, они даже закончили), поэтому я не слишком удивлюсь, если мой ответ станет правильным. Но на данный момент SDK и JDK-это одно и то же.

есть два продукта JavaSE и JavaEE. EE-это веб-приложение/enterprise edition, которое позволяет разрабатывать и запускать веб-приложение. SE-это простой Java-продукт, который не имеет специфики EE, но является подмножеством EE. SE поставляется в двух типах JDK и JRE.

есть одна большая разница, которая может быть не очевидной, и я не уверен, что это относится ко всем операционным системам, но под Windows JRE не имеет серверной точки доступа JVM, только клиентский, JDK имеет оба, и, насколько я знаю, все другие ОС имеют как для JDK, так и для JRE. Реальная разница заключается в том, что JDK содержит компилятор Java, то есть JDK позволяет компилировать и запускать Java из исходного кода, где, поскольку JRE разрешает только запуск байтового кода Java, это источник, который уже был скомпилирован. И да, новые версии связывают ряд дополнительных компонентов, таких как среда редактора NetBeans и Java в базе данных памяти (derby/cloudscape), но это необязательный.

Источник

Как установить JDK и среду разработки IntelliJ IDEA

Начинаем разрабатывать на Java: где взять, как установить и настроить всё, что нужно.

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

Пройдём через это вместе. Установим JDK в Windows, Ubuntu и macOS, и IntelliJ IDEA тоже в Windows, Ubuntu и macOS. Поехали!

Установка Java Development Kit в Windows

Java Development Kit (JDK) — это комплект ПО для разработчиков приложений на Java. Стандартная установка включает в себя интерпретатор, облегчённый интерпретатор JRE, компилятор, библиотеку Java-классов, отладчик, средства архивации и сжатия jar и другое.

Чтобы установить JDK в Windows, нужно:

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

Пишет на Java. Верит в Agile. Пьёт много кофе и не любит грязный код.

1. Скачиваем установочный архив

Нам нужна бесплатная версия — AdoptOpenJDK (она есть под Windows, macOS, Ubuntu и другие платформы).

Идём сюда и выбираем версию JDK (актуальны версии 8+), виртуальную Java-машину (JVM) и свою платформу.

Я выбрал OpenJDK 11 ( LTS ), HotSpot и Windows x64 jdk соответственно:

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

Скачиваем файл по появившейся ссылке (я выделил её жёлтым на скрине выше).

2. Устанавливаем

Извлекаем скачанный архив в папку C:\Program Files\Java\

При этом будет создана подпапка jdk-*номер версии*, а внутри неё появится папка bin.

В результате полный путь до папки bin у меня выглядит так:

3. Настраиваем переменные окружения Windows

Нам нужно создать системную переменную JAVA_HOME, которая будет хранить путь до нашей версии JDK. Это понадобится программам для работы с проектами Java.

Заходим в Панель управления → Система → Дополнительные параметры системы → Дополнительно

А можно и прямо в Панели управления вбить в поиск слово « переменных» (без кавычек). ОС предложит варианты, из которых выбирайте « Изменение системных переменных среды».

У вас откроется окно:

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

Здесь жмём на кнопку « Переменные сред ы».

В новом окне для раздела « Системные переменные» кликаем « Создать». В « Имя переменной» вводим JAVA_HOME (именно так, латиницей в верхнем регистре), а в поле « Значение переменной» подставляем наш путь C:\Program Files\Java\jdk-*номер версии* :

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

Далее в разделе « Переменные сред ы…» редактируем системную переменную Path. Нужно добавить в неё путь к папке с исполняемыми файлами Java, а именно: %JAVA_HOME%\bin (соблюдайте регистр символов):

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

4. Проверяем установку

Запускаем Командную строку Windows. Для этого нажимаем Win + R, а в появившемся окне вводим cmd.exe и жмём на Enter.

Если установка прошла успешно, то ответ покажет версию вашего компилятора:

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

Установка Java Development Kit в Linux (Ubuntu)

Рассмотрим установку JDK на одном из самых популярных дистрибутивов Linux — Ubuntu 20.04 ( LTS ).

Проще всего установить версию, которая входит в пакет Ubuntu. По умолчанию в Ubuntu 20.04 входит версия Open JDK 11.

1. Проверяем ранее установленные версии

Открываем терминал сочетанием клавиш Ctrl + Alt + T и обновляем базу данных пакетов с помощью APT :

Проверяем ранее установленные версии командой:

Если установка уже выполнялась, то мы увидим что-то такое:

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

2. Устанавливаем

Для запуска любых приложений Java нужна JRE (Java Runtime Environment — среда выполнения для языка Java). Но для компиляции и разработки программ требуется JDK (Java Development Kit).

Чтобы установить JRE, вводим в консоль:

Для установки JDK — команду:

3. Проверяем установку

Ответ должен выглядеть примерно так:

Установка Java Development Kit в Linux (macOS)

Этот способ установки использует HomeBrew (менеджер недостающих пакетов для macOS).

1. Устанавливаем

Прежде всего нужно добавить репозиторий в HomeBrew. Для этого открываем терминал (Cmd + N) и вводим:

Устанавливаем OpenJDK 11 командой:

2. Проверяем установку

Ответ должен выглядеть примерно так:

Установка среды разработки IntelliJ IDEA Community (Windows)

Intellij IDEA — это интегрированная среда разработки (IDE), то есть система программных средств для создания проектов на разных языках программирования.

Сегодня это самая популярная IDE для языка Java. А ещё есть Eclipse, NetBeans и немало других, но мы рекомендуем именно IDEA, потому что даже её бесплатная версия обладает широкой функциональностью, подходит для профессиональной разработки и вообще делает Java проще в использовании.

В IDE обязательно входят:

1. Какую версию (редакцию) выбрать

Intellij IDEA доступна в бесплатной (Community) и платной (Ultimate) версиях. Чем они различаются, видно на скрине ниже:

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

Пока что нам хватит возможностей бесплатной версии.

На заметку: IntelliJ предлагает студентам и преподавателям свободный доступ к своим продуктам.

2. Сама установка

Заходим сюда и качаем версию для Windows.

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

Жмём Next (Далее) и выбираем путь для установки:

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

Снова Next, и настраиваем параметры установки:

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

В общем случае это:

Кликаем Next (Далее) и выбираем папку для ярлыков IDEA (оставляем по умолчанию):

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

Нажимаем Install (Установить), после чего стартует установка:

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

Дожидаемся её окончания и жмём Finish (Завершить):

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

3. Запуск IntelliJ IDEA и настройка параметров

При первом запуске принимаем пользовательское соглашение и нажимаем Continue (Продолжить):

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

Далее выбираем тему оформления (доступны тёмная и светлая):

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

Жмём Next: Default plugins и переходим к выбору устанавливаемых плагинов:

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

Если не знаете, что вам точно пригодится, — оставляйте всё как есть. А если, например, с Андроидом вам не работать — выключите соответствующий пункт.

Не волнуйтесь, если надобавляете лишнего или о чём-то забудете. Всё можно будет переиграть — в настройках среды.

После чего нажмите на кнопку Next: featured plugins и выберите другие нужные плагины (или оставляйте всё по умолчанию):

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

И наконец, нажимаем Start using Intellij IDEA.

Вас встретит начальный экран среды разработки (Welcome screen). Здесь можно создать новый проект, открыть или импортировать существующий, а также скачать проект из системы контроля версий:

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

Если вы видите такой же экран — поздравляю, установка и настройка прошли успешно! Приятного обучения!

Установка среды разработки IntelliJ IDEA Community (macOS)

Здесь всё даже легче, чем в Windows. Для начала качаем версию для macOS отсюда (о различии между редакциями Community и Ultimate читайте выше — в пункте про установку на Windows):

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

Копируем файл в « Программы»:

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

Читаем предупреждение ОС и жмём « Открыть»:

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

Принимаем пользовательское соглашение и жмём кнопку Continue (Продолжить):

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

Теперь приложением можно пользоваться. Приятного обучения!

Установка среды разработки IntelliJ IDEA Community (Ubuntu)

Для установки Intellij IDEA открываем Центр приложений Ubuntu:

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

Вводим в поиск слово « Intellij» (без кавычек). Нам нужна IDEA Community (о различии между редакциями Community и Ultimate читайте выше — в пункте про установку на Windows):

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

Выбираем версию и нажимаем кнопку Install (Установить):

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

После установки видим IDEA в меню программ:

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

Запускаем, принимаем пользовательское соглашение и нажимаем кнопку Continue (Продолжить):

Источник

SDK и пример приложений

Раздел “SDK (software development kits) и примеры приложений” аналогичен образцам и описаниям кода, но более обширен и обычно включает в себя целую коллекцию файлов, которые работают вместе как пакет или пример приложения. SDK может включать библиотеки, которые мы загружаем и встраиваем в свое приложение, и может состоять из инструментов, примеров приложений и другого кода.

Что такое SDK?

Термины API и SDK часто используются вместе, но они не являются синонимами. SDK реализуют независимый от языка REST API на определенном языке, таком как Java или C ++. API REST сами по себе не привязаны к какому-либо конкретному языку; обычно мы демонстрируем API, совершая запросы, используя cURL, инструмент командной строки для отправки веб-запросов и получения ответов. Но разработчики не будут использовать запросы cURL при реализации API. Вместо этого они будут реализовывать запросы API, используя язык, на котором написано их приложение.

Например, приложения Python, C++ или Node выполняют запросы API разными способами. Каждый язык имеет свой собственный способ построения запросов к API. Можно использовать Postman или Paw для автоматической генерации простого запроса на определенном языке (см. Автоматическая генерация примеров кода ). SDK выводит реализацию на другой уровень. SDK могут включать в себя гораздо больше файлов или библиотек как часть реализации.

В статье В чем разница между API и SDK? Kristopher Sandoval объясняет SDK следующим образом:

Sandoval сравнивает примеры API и SDK Facebook, чтобы прояснить разницу. Он резюмирует разницу следующим образом: «SDK является строительными блоками приложения, тогда как API является языком его запросов». Другими словами, SDK предоставляет весь необходимый код, необходимый для создания приложения, которое использует API.

Какова роль технического писателя в документировании SDK и примеров приложений

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

Техническому писателю API, документирование SDK и примеров приложений является более сложной задачей, поскольку SDK требуют знания одного или нескольких языков программирования. Вопрос о том, сколько кода нужно знать техническому писателю рассмотрим в модуле Работа техписателя, поэтому здесь в подробности не будем вдаваться. Обычно разработчики не ожидают от вас глубокого знания нескольких языков программирования, но некоторое понимание потребуется для их описания и просмотра документации. При принятии решения о том, называть ли блок кода функцией, классом, методом или другим именем, необходимо иметь базовое понимание терминов, используемых в языке.

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk javaSDK и пример приложений

Если язык незнаком, можно просто взять то, что пишут инженеры, немного почистить его, попробовать пройтись по шагам, чтобы заставить работать любые примеры приложений, и посмотреть, какие отзывы приходят от пользователей. Обычно, если можно установить и работать с примером приложения и убедиться, что базовая документация для запуска приложения работает, а также то, что приложение делает, этого может быть достаточно. Но, конечно, для внесения любого существенного вклада в документацию SDK потребуется знание языка программирования, на котором написан SDK.

Как уже упоминалось в разделе Описание и образцы кода, не нужно документировать, как работает конкретный язык, как работает SDK компании. Предположительно, если инженер загружает Java SDK для API, это происходит потому, что инженер уже знаком с Java. Однако, если API был реализован особым образом в Java, нужно объяснить, почему был принят этот подход. (Конечно, для понимания разницы между документированием Java и документированием определенного подхода в реализации Java также требуется понимание Java.)

Примеры SDK и приложений

В следующих примерах показана документация некоторых примеров SDK и примеров приложений.

OpenWeatherMap API

Хорошая идея, если можно разместить свои примеры приложений и SDK на GitHub. Хранение кода на GitHub преследует две цели: во-первых, оно обычно ложится бременем на разработку поддержки и тестирования примеров кода, а также реагирует на проблемы, которые пользователи могут регистрировать в проекте. Во-вторых, это упрощает предоставление полнофункционального кода, поскольку пользователи могут клонировать проект и немедленно начать работу с ним. Команда разработчиков также может легко выпускать обновления.

Paypal REST SDK

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk javaPayPal PHP sdk

Heroku SDK

что такое sdk java. Смотреть фото что такое sdk java. Смотреть картинку что такое sdk java. Картинка про что такое sdk java. Фото что такое sdk java

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

Если разработчики говорят, что пользователи должны знать X, не стоит доверять их мнению из-за незнания языка. Лучше найти разработчиков на этом языке (даже своих разработчиков в других командах) для проверки документации. Если эти пользователи попросят больше подробностей, стоит связаться с командой разработчиков, чтобы предоставить нужные подробности.

Технические писатели, не знакомые с языком SDK, выступают в качестве посредников между авторами проекта и пользователями проекта. Технические писатели выявляют и устраняют пробелы в документации, и часто управляют публикацией и распространением документов. Но сам контент может быть слишком техническим для большинства технических писателей, играющих роль авторов контента. (Подробнее об этом в серии «Упрощенная сложность» статья под названием Be both a generalist and specialist through your technical acuity)

Amazon SDK

Но даже в этом случае существуют небольшие вариации от одной библиотеки к другой. Как инженеры гарантируют, что они используют то же описание для класса в Java, что и для Ruby и PHP? Инструменты для генерации документации или недостаточно умны, чтобы использовать фрагменты, или включены в общий онлайн-репозиторий. Обычно не используют переменные или другие методы одного источника. В результате, об одних и тех же понятиях могут быть разные описания в документации к разным SDK.

Google Cloud SDK

Google Cloud SDK предоставляет руководства по быстрому запуску для Linux, Debian, Ubuntu и других операционных систем. В руководствах объясняется, как устанавливать, настраивать и управлять командами SDK. Ссылка API для команд также включена.

Если взглянуть на Google Cloud SDK и Amazon SDK станет понятно, что при разнообразии SDK можно документировать и в ширь и в глубь. SDK специфичны для конкретного языка программирования, операционной системы или другого фреймворка, и поэтому попытка документировать эту категорию инструментов может быть сложной. Для документации SDK необходимо тесно сотрудничать с разработчиками и прислушиваться к отзывам пользователей.

👨‍💻 Практическое занятие: SDK

В своем найденном опен-сорс проекте найдем информацию об SDK для API. Ответим на следующие вопросы:

Источник

Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *