Postman – это приложение для работы с API, которое позволит отправлять запросы к сервисам и работать с их ответами.
В данном руководстве будут рассмотрены:
- Создание рабочего пространства (workspace);
- Создание коллекции (collection);
- Создание запроса (request);
- Переименование созданных элементов;
- Удаление созданных элементов.
Почему рассмотрены только workspace, collection и request?
Это базовые элементы Postman которые помогут нам отправить API запрос.
1. Создание рабочего пространства (workspace)
Рабочее пространство Postman поможет организовать работу с запросами API и использовать их в рамках указанной видимости.
На момент написания руководства существует пять типов видимости рабочих пространств:
- Личное (Personal) – только Вы имеете доступ;
- Частное (Private) – только приглашенные члены команды имеют доступ;
- Командное (Team) – все члены команды имеют доступ;
- Партнерское (Partner) – только приглашенные партнеры и члены команды имеют доступ;
- Публичное (Public) – доступно всем.
Как создать рабочее пространство:
- В верхнем меню приложения выберите Workspaces – Create Workspace.
- В открывшейся вкладке обязательно укажите Name (название рабочего пространства), выберите Visibility (видимость рабочего пространства) и нажмите кнопку Create Workspace. Указание Summary (краткое описание) не обязательно.
При успешном создании автоматически откроется интерфейс созданного рабочего пространства.
2. Создание коллекции (collection)
Коллекция Postman поможет упорядочить запросы и элементы API. С помощью коллекций можно упростить обмен запросами используя импорт или экспорт.
Как создать коллекцию:
- Если в рабочем пространстве нет ни одной коллекции, то нажмите Create collection
- Если в рабочем пространстве есть ранее созданные коллекции, то нажмите + Create new collection;
3. Создание запроса (request)
Запросы, то, ради чего мы рассматриваем приложение. Более подробную информацию о запросах можно найти на просторах Интернета.
Как создать запрос несколькими способами:
- Если в коллекции нет ни одного запроса, то выберите коллекцию и нажмите Add a request;
- Также, не зависимо от наличия запроса в коллекции, выберите коллекцию и нажмите … View more action – Add request или можно нажать ПКМ на название коллекции и затем Add request;
4. Переименование созданных элементов
Рабочее пространство
Для переименования рабочего пространства нажмите на название рабочего пространства Open overview of … и на открывшейся вкладке нажмите ЛКМ по названию рабочего пространства.
Коллекция или запрос
При создании коллекции или запроса по умолчанию им присваивается название New Collection и New Request, но можно задать им произвольное название несколькими способами:
- Выберите коллекцию или запрос и нажмите … View more action – Rename;
- Нажмите ПКМ на коллекцию или запрос и выберите Rename;
- Выберите коллекцию или запрос. На открывшейся странице наведите на область справа от названия, появится символ карандаша – нажмите на него;
- Выберите коллекцию или запрос и нажмите сочетание клавиш Ctrl + E.
5. Удаление созданных элементов
Рабочее пространство
- Для удаления рабочего пространства нажмите на название рабочего пространства Open overview of …;
- На открывшейся вкладке нажмите на Workspace Settings;
- На открывшейся вкладке нажмите Delete Workspace;
- В поле Enter workspace name to confirm подтвердите удаление введя название рабочего пространства и нажмите Delete Workspace.
Коллекция или запрос
Удалить коллекцию или запрос можно несколькими способами:
- Выберите коллекцию или запрос и нажмите … View more action – Delete;
- Нажмите ПКМ на коллекцию или запрос и выберите Delete;
- Выберите коллекцию или запрос и на открывшейся вкладке нажмите … View more action – Delete;
- Выберите коллекцию или запрос и нажмите на клавиатуре Delete.
Все способы удаления подтверждаются нажатием Delete.
Важно отметить, что при удалении запрос восстановлению не подлежит, а коллекция будет помещена в Trash и восстановление возможно.