Добро пожаловать в JIRA Server! Этот обзор будет охватывать все, что вам нужно знать, чтобы интегрироваться с JIRA Server. Это включает в себя фреймворк P2 для создания надстроек, а также функции и сервисы JIRA, которые вы можете использовать при интеграции с JIRA.
Привет мир
Если вы уже знаете теорию и хотите перейти прямо в разработку, прочитайте наше руководство по началу работы для создания вашего первой надстройки JIRA Server.
Мы рекомендуем вам прочитать всю эту страницу, если вы новичок в разработке сервера JIRA, но если вы хотите перейти к определенному разделу, используйте приведенные ниже ссылки:
- Разработка с помощью плагинов2(Plugins2): структура для создания надстроек для сервера JIRA Server
- Модули: точки интеграции для взаимодействия с JIRA, включая JIRA UI
- Свойства объекта: хранилища ключевых значений в JIRA
- API JIRA: это включает в себя API REST для платформы JIRA и продуктов JIRA
- Webhooks: пользовательские обратные вызовы через HTTP
- Безопасность: аутентификация и авторизация
- Центр данных JIRA: инструменты для работы с пользовательским интерфейсом JIRA, такие как API-интерфейс Atlassian Connect JS, условия и контекстные параметры.
Создание надстройки
Если вы хотите создать надстройку для сервера JIRA, то вы будете использовать платформу разработки дополнений Atlassian через Atlassian SDK. Платформа состоит из рамки Plugins2 (также известной как фреймворк P2) и набора компонентов, которые предоставляют полезные инструменты для разработчиков, как показано ниже.
РИСУНОК
Дополнительные сведения о компонентах на этой платформе см. В разделе Общие компоненты Atlassian Platform.
Надстройка JIRA Plugins2 представляет собой набор кода, ресурсов и файлов конфигурации, которые могут быть установлены в JIRA. По сути, надстройки могут выполнять следующие действия:
- Добавлять содержимое или функции, такие как страницы, панели, отчеты, функции JQL, гаджеты, в определенных определенных местах в интерфейсе JIRA через модули.
- Обеспечивать безопасные запросы API JIRA.
- Слушать и отвечать на webhooks, выпущенные Atlassian.
Для получения дополнительной информации см. Обзор JIRA Plugins2.
Разработка с помощью плагинов2
Если вы создаете надстройку с помощью Plugins2, вам также нужно будет понять ряд ключевых процессов разработки:
- Внедрение безопасности: внедрение безопасности является важной частью интеграции с JIRA. Надежная аутентификация и авторизация помогают предотвратить вредоносный доступ к данным клиента. Подробнее об аутентификации и авторизации для JIRA Server см. в обзоре безопасности.
- Перечисление вашей надстройки на Atlassian Marketplace и внедрение лицензирования: список вашей надстройки на Atlassian Marketplaces и лицензирование необходимы, если вы хотите сделать свою надстройку доступной для общественности. Дополнительную информацию см. В документации Marketplace.
-
Проектирование вашей надстройки: поскольку надстройки Plugins2 могут вставлять контент непосредственно в приложение Atlassian host, крайне важно, чтобы надстройки были визуально совместимы с дизайном приложения Atlassian. Наши дизайнеры и разработчики создали ряд ресурсов, которые помогут вам в этом:
- Руководящие принципы проектирования Atlassian - наши руководящие принципы проектирования определяют основные взаимодействия с приложениями Atlassian.
- Пользовательский интерфейс Atlassian(AUI) - AUI - это библиотека многократно используемых внешних компонентов пользовательского интерфейса.
Модули
Модули являются наиболее важным компонентом вашей надстройки или интеграции JIRA. Проще говоря, это точки интеграции, которые ваша надстройка использует для обеспечения богатых взаимодействий с JIRA. Существует два типа модулей: базовые фреймы, которые позволяют отображать контент в разных местах JIRA и более продвинутые модули, которые позволяют вам предоставлять расширенные функциональные возможности JIRA. Служба JIRA Service Desk и JIRA Software также имеют свои собственные модули для конкретных приложений (только для интерфейса).
Дополнительные сведения см. в разделе О модулях JIRA.
Свойства объекта
Свойства объекта - это хранилища ключевых значений, прикрепленные к объектам JIRA, которые могут быть созданы, обновлены и удалены с помощью API JIRA REST. Это мощная система для хранения данных на хосте JIRA; она легко поддерживает импорт, экспорт и миграцию между экземплярами, поскольку данные хранятся локально с экземпляром JIRA. Вот как свойства объекта могут помочь вам в интеграции с JIRA-сервером:
- Упростите надстройку или интеграцию, уменьшив количество данных, хранящихся на вашем собственном сервере.
- Повышайте производительность, оценивая объекты entity_property_equal_to в процессе.
- Внедряйте расширенные функции, такие как интеграция JQL, с помощью извлечения поиска.
Чтобы узнать больше о свойствах объекта JIRA, см. Свойства объекта.
API JIRA
Используйте JIRA API для взаимодействия с JIRA от интеграции. Вы также должны прочитать обзор безопасности, чтобы узнать, как обеспечить взаимодействие с API-интерфейсами JIRA.
API REST
Вы должны использовать API REST для большинства интеграций. Каждый из приложений JIRA Server имеет REST API, который позволяет вам взаимодействовать с объектами в этом приложении (например, спринт для JIRA Software). REST API серверной платформы JIRA является общей для всех продуктов JIRA.
- Серверная платформа JIRA REST API (последняя версия)
- API REST сервера програмного обеспечения JIRA (последняя версия)
- JIRA Service Desk Server REST API (последняя версия)
Дополнительные сведения см. В разделе О API-интерфейсах REST API JIRA. См. также раздел Webhooks.
API Java
API-интерфейсы Java в основном используются при создании надстройки P2. Подобно API-интерфейсам REST, у каждого из приложений JIRA-сервера есть Java API.
- Серверная платформа JIRA REST API (последняя версия)
- API REST сервера програмного обеспечения JIRA (последняя версия)
- JIRA Service Desk Server REST API (последняя версия)
Webhooks
Webhooks - это исходящие сообщения от JIRA, которые позволяют вашей надстройке или интеграции реагировать на события, например, кто-то переводит задачу или закрывает спринт. Как и API REST, существует набор Webhooks на уровне платформы и дополнительные расширенные Webhooks для JIRA Software и JIRA Service Desk.
Чтобы узнать больше о webhooks, см. Webhooks.
Центр данных JIRA
Центр данных JIRA - это корпоративная реализация JIRA, обеспечивающая высокую доступность и производительность по масштабам. Если вы разрабатываете для центра данных JIRA, вам необходимо знать принципы создания надстроек для высокой доступности и кластеризованных сред.
Дополнительные сведения см. в разделе Центр данных JIRA.
Начало
Время для начала работы с сервером разработки JIRA! Ознакомьтесь с нашим руководством по началу работы, чтобы узнать, как настроить среду разработки и создать надстройку сервера JIRA.