ДОКУМЕНТАЦИЯ API В POSTMAN

API ДОКУМЕНТАЦИЯ В POSTMAN

< p>В предыдущих статьях Postman Tutorial мы рассмотрели «GUID в Postman».

В этой статье «Документация по API» я продемонстрирую, как можно реализовать эту концепцию и получить четкое представление об этом.

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

Мы можем отредактировать описание API, чтобы всем товарищам по команде было проще понять API.

API ДОКУМЕНТАЦИЯ В POSTMAN

Мы можем добавить описания параметров также. Все параметры в формате ключ-значение можно описать в описании.

API DOCUMENTATION IN POSTMAN

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

API ДОКУМЕНТАЦИЯ В POSTMAN

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

Мы даже можем просмотреть нашу коллекцию на паутина. Нажмите на многоточие и выберите Просмотреть в Интернете. Коллекция появится в браузере.

API ДОКУМЕНТАЦИЯ В POSTMAN

TAG: qa

От QA genius

Adblock
detector