Forwarded from Business | System analyst
API (Application Programming Interface) – это набор правил и протоколов, позволяющих различным программным системам взаимодействовать друг с другом. В современном мире разработки программного обеспечения API стал неотъемлемой частью системной архитектуры, позволяя разделить функциональность программ на логические блоки и предоставлять возможность использования этих блоков другими системами, как внутренними, так и внешними.
При разработке и эксплуатации API одним из наиболее важных и часто недооцениваемых аспектов является его документирование. Хорошо задокументированное API может стать ключевым фактором успеха проекта, упростив интеграцию с ним и ускорив процесс разработки.
Документирование API представляет собой процесс создания достаточно подробной и понятной документации, которая описывает все функции, структуру данных, методы взаимодействия и требования для его использования. Документация должна быть доступной и понятной для разработчиков, которые будут интегрировать свои системы с API.
Важными аспектами при документировании API являются:
✍🏼1. Описание ресурсов и методов: Документация должна содержать описание всех доступных ресурсов и методов, которые поддерживает API. Каждый ресурс должен быть подробно описан, включая его структуру данных, список полей, доступные методы и возможные запросы/ответы.
📌2. Примеры использования: Хорошая документация должна содержать множество примеров использования API. Примеры помогут разработчикам быстрее разобраться в функциональности и особенностях API, а также позволят им быстрее начать пользоваться им.
🌐3. Схемы данных: Для каждого ресурса API должны быть предоставлены схемы данных, описывающие структуру объектов, передаваемых по API. Схемы данных могут использоваться в процессе валидации запросов и ответов, а также для генерации моделей данных в клиентском коде.
😨4. Ошибки и исключения: Документация должна содержать список возможных ошибок и исключений, которые могут возникнуть при работе с API. Каждая ошибка должна быть подробно описана, включая информацию о причинах ее возникновения и возможные способы ее решения.
🔢5. Версионность: Важным аспектом документации API является указание версии API, чтобы разработчики могли быть уверены, что они используют актуальную версию. Необходимо предоставлять возможность переключения на более новые версии, сохраняя обратную совместимость с предыдущими версиями.
⏱6. Частые обновления: Документация API должна быть актуальной и регулярно обновляться с выпуском новых функций и исправлениями. Это поможет снизить степень путаницы у разработчиков и повысит удовлетворенность пользователей API.
📑7. Интерактивная документация: Для удобства использования API стоит предусмотреть возможность создания интерактивной документации, где разработчики могут отправлять запросы и видеть результаты в реальном времени, а также иметь возможность пробовать различные последовательности запросов.
Правильное документирование API является важным шагом для обеспечения успешной интеграции и сотрудничества с другими системами. Четкая, полная и понятная документация может значительно упростить жизнь разработчикам и сэкономить время и усилия при работе с API.
Материалы по теме:
- Документирование API
- Что такое API документация и как ее правильно составить и использовать?
- How to Write Good API Documentation
При разработке и эксплуатации API одним из наиболее важных и часто недооцениваемых аспектов является его документирование. Хорошо задокументированное API может стать ключевым фактором успеха проекта, упростив интеграцию с ним и ускорив процесс разработки.
Документирование API представляет собой процесс создания достаточно подробной и понятной документации, которая описывает все функции, структуру данных, методы взаимодействия и требования для его использования. Документация должна быть доступной и понятной для разработчиков, которые будут интегрировать свои системы с API.
Важными аспектами при документировании API являются:
✍🏼1. Описание ресурсов и методов: Документация должна содержать описание всех доступных ресурсов и методов, которые поддерживает API. Каждый ресурс должен быть подробно описан, включая его структуру данных, список полей, доступные методы и возможные запросы/ответы.
📌2. Примеры использования: Хорошая документация должна содержать множество примеров использования API. Примеры помогут разработчикам быстрее разобраться в функциональности и особенностях API, а также позволят им быстрее начать пользоваться им.
🌐3. Схемы данных: Для каждого ресурса API должны быть предоставлены схемы данных, описывающие структуру объектов, передаваемых по API. Схемы данных могут использоваться в процессе валидации запросов и ответов, а также для генерации моделей данных в клиентском коде.
😨4. Ошибки и исключения: Документация должна содержать список возможных ошибок и исключений, которые могут возникнуть при работе с API. Каждая ошибка должна быть подробно описана, включая информацию о причинах ее возникновения и возможные способы ее решения.
🔢5. Версионность: Важным аспектом документации API является указание версии API, чтобы разработчики могли быть уверены, что они используют актуальную версию. Необходимо предоставлять возможность переключения на более новые версии, сохраняя обратную совместимость с предыдущими версиями.
⏱6. Частые обновления: Документация API должна быть актуальной и регулярно обновляться с выпуском новых функций и исправлениями. Это поможет снизить степень путаницы у разработчиков и повысит удовлетворенность пользователей API.
📑7. Интерактивная документация: Для удобства использования API стоит предусмотреть возможность создания интерактивной документации, где разработчики могут отправлять запросы и видеть результаты в реальном времени, а также иметь возможность пробовать различные последовательности запросов.
Правильное документирование API является важным шагом для обеспечения успешной интеграции и сотрудничества с другими системами. Четкая, полная и понятная документация может значительно упростить жизнь разработчикам и сэкономить время и усилия при работе с API.
Материалы по теме:
- Документирование API
- Что такое API документация и как ее правильно составить и использовать?
- How to Write Good API Documentation
👍6🔥5❤3
Неизменная ценность ручных тестировщиков: важность и преимущества в эпоху автоматизации
Источник статьи | Testing QA
Источник статьи | Testing QA
👍5👌3❤2
Forwarded from QApedia | Тестирование
Обзор новой версии сертификации ISTQB Foundation Level 4.0 (2024) для Тестировщиков
Статья для тех, кто хочет узнать что нового в версии 4.0 но не хочет читать весь силлабус, ну или думает читать или нет:)
Перейти к статье | QApedia
Статья для тех, кто хочет узнать что нового в версии 4.0 но не хочет читать весь силлабус, ну или думает читать или нет:)
Перейти к статье | QApedia
❤4🔥2👍1
Статистика по QA вакансиям
Статистика QA вакансий и резюме. Июль 2023
Статистика за июнь по QA вакансиям на HeadHunter
Статистика за май по QA вакансиям на HeadHunter
Статистика QA вакансий и резюме. Июль 2023
Статистика за июнь по QA вакансиям на HeadHunter
Статистика за май по QA вакансиям на HeadHunter
Хабр
Статистика QA вакансий и резюме. Июль 2023
Раз в месяц я и команда вручную собираем статистику по вакансиям и резюме тестировщиков с разных ресурсов. Сегодня — статистика за июль. Мы не делаем выводы, а оставляем сухие цифры. Много...
🔥3❤2👍1🤣1
This media is not supported in your browser
VIEW IN TELEGRAM
Когда разраб принёс тестировщику новую фичу:
😁18🤣7🔥2
Как мы поднимаем dev-стэнд(ы) и гоняем полноценные тесты api на каждый коммит
Источник статьи | Testing QA
Источник статьи | Testing QA
Хабр
Как мы поднимаем dev-стэнд(ы) и гоняем полноценные тесты api на каждый коммит
Мы в API отказались от большого количества unit -тестов в пользу большого количества интеграционных/системных тестов, чтобы: не писать тесты на каждую небольшую функцию системы (которые могут...
Младший ИТ-фактчекер в агентство Glyph media
Задачи:
Условия:
Что делать, чтобы откликнуться, что по деньгам, требования к кандидатам и другие подробности: https://vc.ru/s/glyph-media/795319-mladshiy-it-faktcheker
Задачи:
• Проверять авторские материалы. • Разбираться в специфике ИТ-текстов. • Оценивать полноту раскрытия темы, адекватность первоисточников и ссылок. • Проверять корректность использования терминов, сверять цифры и факты с первоисточниками. • Размечать тексты, возвращать авторам, проверять качество доработки.Условия:
• На старте возможен парт-тайм — совместительство с учебой или другой работой. • Гибкая нагрузка, постепенное развитие (можем стартовать с небольшой части обязанностей). • Всегда есть возможности для роста, если освоитесь и захотите редактировать тексты, больше зарабатывать. При желании можно совмещать с позицией старшего редактора (+ до 80 тыс.)Что делать, чтобы откликнуться, что по деньгам, требования к кандидатам и другие подробности: https://vc.ru/s/glyph-media/795319-mladshiy-it-faktcheker
❤2👍1👌1
Forwarded from Analyst IT
Виды баз данных. Большой обзор типов СУБД
В статье будут рассмотрены следующие типы баз данных:
• Реляционные
• Ключ-значение
• Документо-ориентированные
• Базы данных временных рядов
• Графовые базы данных
• Поисковые базы данных (Search Engines)
• Объектно-ориентированные базы данных
• RDF (Resource Denoscription Framework)
• Wide Column Stores
• Мультимодальные СУБД
• Native XML СУБД
• GEO/GIS (пространственные) и специализированные СУБД
• Event СУБД (баз данных переходов состояний)
• Контентные СУБД
• Навигационные (Navigational) СУБД
• Векторные базы данных
Читать статью | Analyst IT
В статье будут рассмотрены следующие типы баз данных:
• Реляционные
• Ключ-значение
• Документо-ориентированные
• Базы данных временных рядов
• Графовые базы данных
• Поисковые базы данных (Search Engines)
• Объектно-ориентированные базы данных
• RDF (Resource Denoscription Framework)
• Wide Column Stores
• Мультимодальные СУБД
• Native XML СУБД
• GEO/GIS (пространственные) и специализированные СУБД
• Event СУБД (баз данных переходов состояний)
• Контентные СУБД
• Навигационные (Navigational) СУБД
• Векторные базы данных
Читать статью | Analyst IT
Хабр
Виды баз данных. Большой обзор типов СУБД
Часто, в обзорах видов баз данных упоминают реляционные и “другие”, “NoSQL” и т.д., либо приводят самые основные типы СУБД (базы данных), забывая о редких. В данной статье я постараюсь описать...
👍8❤3🔥2