Документация: описываем методы API в зависимости от способа интеграции в приложении

Поделиться
HTML-код
  • Опубликовано: 7 сен 2024
  • Ведущий аналитик MediaSoft рассказала:
    - Что такое API и зачем его документировать
    - Идеальный шаблон описания API
    - Что обязательно нужно указать в документации, а чем можно пренебречь. Как на описание повлияет способ интеграции в системе
    - Где искать примеры хорошей документации

Комментарии • 2

  • @user-uu4ro5iz5n
    @user-uu4ro5iz5n 9 месяцев назад +3

    Можно пожалуйста прикрепить ссылки идеальных шаблонов документации в описание?

    • @mediasoft_team
      @mediasoft_team  9 месяцев назад +1

      Хороший пример написания документации можно найти здесь: habr.com/ru/articles/667884/

Следующие
Автовоспроизведение
Что сказать на собеседовании про обработку топика Kafka36:38Что сказать на собеседовании про обработку топика Kafka
Что сказать на собеседовании про обработку топика KafkaАндрей Суховицкий
Просмотров 7 тыс.
Amplicode - конвейер для Spring-приложений прямо в IntelliJ IDEA3:28:20Amplicode – конвейер для Spring-приложений прямо в IntelliJ IDEA
Amplicode - конвейер для Spring-приложений прямо в IntelliJ IDEAAmplicode
Просмотров 1 тыс.
Интеграции с применением REST, SOAP, gRPC, GraphQL: обзор протоколов, как выглядят, где используются23:39Интеграции с применением REST, SOAP, gRPC, GraphQL: обзор протоколов, как выглядят, где используются
Интеграции с применением REST, SOAP, gRPC, GraphQL: обзор протоколов, как выглядят, где используютсяMediaSoft
Просмотров 8 тыс.
Top 10 Best Jumpshots in NBA 2K25 from EVERY YouTuber (Joe Knows, Double H + More)10:33Top 10 Best Jumpshots in NBA 2K25 from EVERY YouTuber (Joe Knows, Double H + More)
Top 10 Best Jumpshots in NBA 2K25 from EVERY YouTuber (Joe Knows, Double H + More)Choc
Просмотров 133 тыс.
FlightReacts 1ST TIME Playing NBA 2K25 Park & THIS HAPPENED! (OLD TOWN FLYERS PARK EVENT!!)48:17FlightReacts 1ST TIME Playing NBA 2K25 Park & THIS HAPPENED! (OLD TOWN FLYERS PARK EVENT!!)
FlightReacts 1ST TIME Playing NBA 2K25 Park & THIS HAPPENED! (OLD TOWN FLYERS PARK EVENT!!)NotYourAverageFlight
Просмотров 552 тыс.
Minecraft Movie Looks Bad06:09Minecraft Movie Looks Bad
Minecraft Movie Looks Badpenguinz0
Просмотров 3,8 млн
TZUYU "Run Away" M/V03:25TZUYU "Run Away" M/V
TZUYU "Run Away" M/VJYP Entertainment
Просмотров 5 млн
Брокеры сообщений RabbitMQ, Kafka и Redis в работе системного аналитика: как и когда использовать27:51Брокеры сообщений RabbitMQ, Kafka и Redis в работе системного аналитика: как и когда использовать
Брокеры сообщений RabbitMQ, Kafka и Redis в работе системного аналитика: как и когда использоватьMediaSoft
Просмотров 11 тыс.
Идеальный USE CASE: как описать сценарий, чтобы его не вернули на доработку24:46Идеальный USE CASE: как описать сценарий, чтобы его не вернули на доработку
Идеальный USE CASE: как описать сценарий, чтобы его не вернули на доработкуMediaSoft
Просмотров 9 тыс.
Что такое REST на самом деле?11:32Что такое REST на самом деле?
Что такое REST на самом деле?Merion Academy
Просмотров 72 тыс.
Что такое SOAP. SOAP и REST. программирование разработка3:03Что такое SOAP. SOAP и REST. программирование разработка
Что такое SOAP. SOAP и REST. программирование разработкаХочу вАйти
Просмотров 5 тыс.
OpenAPI и Swagger Editor - своё описание REST API с нуля16:35OpenAPI и Swagger Editor - своё описание REST API с нуля
OpenAPI и Swagger Editor - своё описание REST API с нуляIT как Конструктор
Просмотров 83 тыс.
Партиционирование в Kafka: что это такое, как работает механизм хранения данных в Kafka + кейсы27:47Партиционирование в Kafka: что это такое, как работает механизм хранения данных в Kafka + кейсы
Партиционирование в Kafka: что это такое, как работает механизм хранения данных в Kafka + кейсыMediaSoft
Просмотров 2,1 тыс.
Вопросы и ответы по REST API: собеседование на системного аналитика59:21Вопросы и ответы по REST API: собеседование на системного аналитика
Вопросы и ответы по REST API: собеседование на системного аналитикаGetAnalyst
Просмотров 3,7 тыс.
Elasticsearch: искать, фильтровать и не сломать34:50Elasticsearch: искать, фильтровать и не сломать
Elasticsearch: искать, фильтровать и не сломатьMediaSoft
Просмотров 9 тыс.
Дмитрий Уланов - AsyncAPI для описания асинхронных интеграций46:17Дмитрий Уланов — AsyncAPI для описания асинхронных интеграций
Дмитрий Уланов - AsyncAPI для описания асинхронных интеграцийFlow — конференция про системный и бизнес-анализ
Просмотров 460
КТО АХМЕДОВА ПО ПРОФЕССИИ? #женскийфорум00:16КТО АХМЕДОВА ПО ПРОФЕССИИ? #женскийфорум
КТО АХМЕДОВА ПО ПРОФЕССИИ? #женскийфорумeasycom
Просмотров 171 тыс.
АНГЕЛ и ДЕМОН Управляют МОЕЙ ЖИЗНЬЮ !17:44АНГЕЛ и ДЕМОН Управляют МОЕЙ ЖИЗНЬЮ !
АНГЕЛ и ДЕМОН Управляют МОЕЙ ЖИЗНЬЮ !A4
Просмотров 3 млн
Нарвался на сотрудника ФСБ⚡️01:00Нарвался на сотрудника ФСБ⚡️
Нарвался на сотрудника ФСБ⚡️Edward Bil
Просмотров 143 тыс.
Прием в первый класс (1969) #ссср #школа00:59Прием в первый класс (1969) #ссср #школа
Прием в первый класс (1969) #ссср #школаСоветские фильмы, спектакли и телепередачи
Просмотров 2,3 млн
Путин - госизменщик! Россиянка подала заявление в ФСБ на Путина и депутатов Госдумы04:27Путин - госизменщик! Россиянка подала заявление в ФСБ на Путина и депутатов Госдумы
Путин - госизменщик! Россиянка подала заявление в ФСБ на Путина и депутатов Госдумыsotavision
Просмотров 280 тыс.
ПУТЬ ОТ УЛИЦЫ ДО БОЙЦА МИРОВОГО УРОВНЯ! #shorts00:56ПУТЬ ОТ УЛИЦЫ ДО БОЙЦА МИРОВОГО УРОВНЯ! #shorts
ПУТЬ ОТ УЛИЦЫ ДО БОЙЦА МИРОВОГО УРОВНЯ! #shortsHARD_MMA
Просмотров 197 тыс.
Джарахов про ситуацию с Кукояками #джарахов #кукояки #instasamka #инстасамка00:44Джарахов про ситуацию с Кукояками #джарахов #кукояки #instasamka #инстасамка
Джарахов про ситуацию с Кукояками #джарахов #кукояки #instasamka #инстасамкаДЖАРАХОВ
Просмотров 113 тыс.
🛑 ты за кого?00:11🛑 ты за кого?
🛑 ты за кого?Арсений Бардаш
Просмотров 34 тыс.