Создание и использование кнопки «Запуск в Postman


Эй, что это за кнопка Run in Postman?

Привет, здорово, что вы спрашиваете. Кнопка Run in Postman — это способ помочь другим начать работу с вашим API. Это код для встраивания, который можно использовать в HTML или Markdown и который показывает оранжевую кнопку в вашем документе с надписью «Run in Postman». Когда вы выбираете ее, она форкает исходную Коллекцию в ваше рабочее пространство. Он также может включать среду, так что все, что нужно, чтобы начать играть с вашим API, уже включено.

Подождите, я понял «embed-code», и я знаю HTML и Markdown, но что такое коллекция и рабочая среда, вы сказали?

Рабочее пространство. Рабочее пространство можно сравнить с физической «мастерской» для создания вещей. В рабочем пространстве хранится все, что нужно для работы с API: инструменты (окружения), чертежи (API), материалы (запросы), инструкции (документация), а также экспериментальные установки (макеты серверов). Все это уже довольно продвинуто, но вы дойдете до этого!

Может быть, не сегодня, верно? А как насчет одиночных запросов?

Коллекцию можно сравнить с верстаком. Она находится в вашей мастерской, так называемом рабочем пространстве, и вы можете расположить там все свои запросы так, как вам нужно. Вы можете иметь несколько Коллекций в своем рабочем пространстве, так же как и несколько верстаков в мастерской.
Теперь с помощью кнопки Run in Postman вы позволяете кому-то другому сделать форк (не совсем копию, я объясню это через минуту) из одной из ваших Коллекций, так что они, по сути, делают снимок одного из ваших рабочих мест (Коллекции) и имеют его точную копию в своем собственном рабочем пространстве. Вы также можете указать им, какие инструменты (среда) лучше всего использовать для данного проекта.

Можете ли вы показать мне кнопку Postman?

Конечно, вот, пожалуйста:

Хм, хорошо. И это все?

Вся прелесть не в кнопке. Это просто SVG. Вы можете придать ей любой вид. Красота в функциональности. Вы создаете ее из любой коллекции, которую хотите продвигать, включая среду или нет, а Postman берет на себя все заботы о бэкенде. Вы сможете вставить этот Markdown или HTML код в свою документацию, в README.md на GitHub, на свою веб-страницу или куда угодно, и узнать, сколько людей форкнули вашу Коллекцию, и как они используют ваш API. Они получают доступ к документации, которую вы включили в свою коллекцию. Все это поможет вам сделать использование вашего API приятным, а не сложным.

Можете ли вы показать мне, как создать такую кнопку? Можно ли ее автоматизировать?

Конечно. Вы переходите к коллекции, которой хотите поделиться, выбираете меню с тремя точками из коллекции (не запрос!) и выбираете «Поделиться».

В накладке вы можете определить, как вы хотите поделиться. Выберите «Через запуск в Postman», сделайте его HTML или Markdown, выберите окружение для включения, если необходимо, а затем скопируйте код в буфер обмена и вставьте его куда хотите.

Важно отметить, что вы можете создавать только кнопки RIP, так мы называем кнопки Run in Postman внутри компании, из ваших собственных коллекций. Есть еще вопросы?

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

Оцените статью
devanswers.ru
Добавить комментарий