Atlassian Confluence REST API

Как работать с REST API Confluence.

Eng

Atlassian_Python О чем этот топик?

  • Структура API в системе Confluence.
  • Объекты, файлы, статьи, родство и проч.
  • Формирование запроса(адреса) в API Confluence
  • Открытие сессии и удержание её в памяти — !
  • Формирование заголовков при помощи модуля requests и — json !
  • Отправка файла, содержания файла, вики-разметки на сервер Confluence — !
  • Интерпретируем ответы от сервера

Что такое Atlassian Confluence вы можете почитать здесь:

  • https://www.atlassian.com/software/confluence
  • https://ru.wikipedia.org/wiki/Confluence

Кому нужен этот топик?

Тем мученикам, которые хотят автоматизировать процесс написания/отправки документации в разработке.

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

Мне самому, чтобы не забыть свой «подвиг» и все его наработки, так как память имеет свойство «стираться».

 

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

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

Для нетерпеливых или тех, кто быстро схватывает и кому достаточно просто посмотреть код или часть его — выкладываю черновой, но рабочий вариант всего этого процесса, сразу предупреждаю, это не пример для подражания, это черновой вариант:

 

 

trianglesis

Об авторе trianglesis

Александр Брюндтзвельт - гений, филантроп, 100 гривен в кармане. Этот блог - "сток" моих мыслей и заметок. Достаточно одного взгляда на него, чтобы понять, что такой же бардак творится у меня в голове. Если вам этот бардак интересен - милости прошу.
Закладка Постоянная ссылка.