Postman tutorial: how to use postman tool for api testing

Создание коллекции почтальона.

Коллекция в Postman — это серия HTTP-запросов. Почтальон сохраняет все аспекты запросов, включая заголовки и тела сообщений. Следовательно, мы можем запускать запросы последовательно как полуавтоматические тесты .

Начнем с создания новой коллекции. Мы можем щелкнуть стрелку раскрывающегося списка на кнопке New и выбрать Collection :

Когда появится диалоговое окно СОЗДАТЬ НОВУЮ КОЛЛЕКЦИЮ , мы можем назвать нашу коллекцию « foo API test ». Наконец, мы нажимаем кнопку Create , чтобы наша новая коллекция появилась в списке слева:

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

How to Run Collections using Newman

Another way to run a collection is via Newman. The main differences between Newman and Collection Runner are the following:

  1. Newman is an add-on for Postman. You will need to install it separately from the Native App.
  2. Newman uses the command line while Collection Runner has a GUI.
  3. Newman can be used for continuous integration.

To install Newman and run our collection from it, do the following:

Step 1) Install nodejs using this link: http://nodejs.org/download/

Step 2) Open the command line and enter

 npm install -g newman

Newman should now be installed on your computer.

Step 3) Once Newman has been installed, let’s go back to our Postman workspace.In the Collections box, click on the three dots. Options should now appear. Select Export.

Step 4) Choose Export Collection as Collection v2.1 (Recommended) then click Export.

Step 5) Select your desired location then click Save. It is advisable to create a specific folder for your Postman tests. A collection should now be exported to your chosen local directory.

Step 6) We will also need to export our environment. Click on the eye icon beside the environment dropdown in Global, select Download as JSON. Select your desired location then click Save. It is advisable that the environment should be in the same folder as your collection.

Step 7) Environment should now be exported to the same local directory as Collection.

Step 8) Now go back to command line and change the directory to where you have saved the collection and environment.

 cd C:\Users\Asus\Desktop\Postman Tutorial

Step 9) Run your collection using this command:

 newman run PostmanTestCollection.postman_collection.json -e Testing.postman_globals.json

Run results should now appear such as below.

For guide is a reference to some basic Newman codes for execution:

  1. Run a collection only. This can be used if there is no environment or test data file dependency.
newman run <collection name>

Run a collection and environment. The -e indicator is for environment.

newman run <collection name> -e <environment name>

Run a collection with desired no. of iterations.

newman run <collection name> -n <no.of iterations>

Run with data file.

newman run <collection name> --data <file name>  -n <no.of iterations> -e <environment name>

Set delay time. This is important as tests may fail if it is run without delay due to requests being started without the previous request completing processing on the endpoint server.

newman run <collection name> -d <delay time>

Действие 7. Получение маркера доступа приложения

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

  1. Выберите папку Приложение.
  2. Выберите вкладку Авторизация.
  3. В разделе Настройка нового маркера щелкните вкладку Параметры конфигурации. Оставьте предварительно настроенные значения для всех полей, включая Тип предоставления разрешения, для которого задано значение .
  4. Прокрутите страницу вправо и щелкните Получить новый маркер доступа.
  5. Щелкните Продолжить, а затем Использовать маркер.

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

История и коллекция запросов

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

Наиболее важные запросы рекомендуется сохранять в коллекции. Чтобы сделать это, достаточно нажать на кнопку New на верхней панели, выбрать пункт Collection и ввести название (на выбор пользователя). Теперь любой запрос будет добавлен в перечень нажатием на кнопку Create и, после заполнения всех данных, кнопку Save (до отправки на сервер).

Использование Postman

С помощью Postman тестировщик может:

  • составлять и отправлять HTTP-запросы к API;
  • создавать коллекции (набор последовательных запросов) и папки запросов для сокращения времени тестирования;
  • менять параметры запросов (например ключи авторизации и URL);
  • менять окружения для запросов (например на тестовом стенде, локально или на сервере);
  • добавлять при вызове API контрольные точки (фиксацию момента передачи данных);
  • проводить автоматизированное тестирование API по коллекции запросов с помощью Collection Runner.

Для работы с серверами программа использует протокол HTTP. Тестировщик отправляет тестовые запросы от клиента на сервер и получает ответ, есть ли ошибка в работе API.

Postman доступен в виде приложения для Windows, Linux и macOS, а также в web-интерфейсе (для его работы нужно установить программу Postman Desktop Agent). Вот как выглядит работа с коллекциями запросов:

  1. Коллекция запросов для теста API. Внутри коллекции запросы можно объединять в папки.
  2. Вкладка запроса из коллекции.
  3. Выбор метода для запроса (GET, POST, PUT, DELETE).
  4. URL запроса на сервере.
  5. Кнопка отправки запроса.
  6. Выбор параметров запроса (ключи и значения — например, только удаленные объекты).
  7. Результат выполнения запроса (код, тело и время ответа, а также размер полученных данных).

Коллекция — это файл проекта со связанными запросами. Обычно запросы для тестирования одного API описывают в одной коллекции. Внутри коллекции запросы можно объединить в папки, например по разным версиям API или тестируемым элементам приложения.

В Postman есть инструмент Collection Runner. Он позволяет одновременно выполнять все запросы из коллекции или папки с нужным количеством итераций и в нужном порядке. После выполнения всех запросов Collection Runner выдает отчет с пометками об успешности запросов и кодами статуса.

Для автоматизированных тестах к коллекциям, папкам и запросам можно применять скрипты на JavaScript. Например, с помощью скриптов можно использовать результат выполнения одного запроса как условия для другого.

How to Create Collections

Collections play an important role in organizing test suites. It can be imported and exported making it easy to share collections amongst the team. In this tutorial, we will learn how to create and execute a collection.

Let’s start in creating a collection:

Step 1) Click on the New button at the top left corner of the page.

Step 2) Select Collection. Create collection window should pop up.

Step 3) Input the desired collection name and description then click create. A collection should now be created.

Step 4) Go back to the previous Get request. Click Save

Step 5)

  1. Select Postman Test Collection.
  2. Click Save to Postman Test Collection

Step 6) Postman test collection should now contain one request.

Step 7) Repeat steps 4-5 for the previous Post request so that collection will now have two requests.

What are examples?

In Postman, an example is a tightly-coupled request and response pair. Each example is made up of a request part (method, URL, parameters, headers, and body) as well as a response part (status code, body, and headers). You create examples by adding them to requests in collections, and one request can have multiple examples.

Having multiple examples for one request is useful for illustrating the different ways an endpoint can respond to a request. You might have examples that respond with different status codes (such as 200 or 404) or that return different data (or no data at all).

Examples are useful in several ways. Developers and testers can refer to examples to better understand how an endpoint should function in different scenarios. Examples can also be used to set up mock servers, so developers and testers can start writing code against your API—even before it’s complete. In addition, you can include examples in your API’s public documentation to help anyone in the world who uses your API.

Фичи, которые уже на подходе

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

Функции

Однако, так как это переменные (пусть и динамические), их нельзя использовать как функции: они не параметризуемы, следовательно взять хеш от строки не получится.

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

А что если мы хотим посчитать хэш от строки? Легко!

Можно заметить, что в качестве параметров даже можно передавать переменные! В этом месте пытливый читатель может заподозрить неладное…

Использование JavaScript в выражениях

… И не зря! Когда формировались требования к функциям, мы вдруг пришли к выводу, что в выражениях нужно давать писать валидный javascript. Поэтому теперь вы вольны писать выражения в духе:

И все это без скриптов прямо в полях ввода!

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

Продвинутое автодополнение

На данный момент TestMace имеет стандартное автодополнение, которое выглядит следующим образом:

Здесь помимо автодополняемой строки указывается к чему принадлежит данная строка. Работает данный механизм только в выражениях, обрамленных скобками ${}.

Как можно заметить, добавились визуальные маркеры, которые указывают на тип переменной (например, строка, число, массив и т.д.). Также можно менять режимы автодополнения (например, можно выбрать автодополнение переменными или заголовками). Но даже это не самое главное!

Во-первых, автодополнение работает даже в выражениях (где это возможно). Вот как это выглядит:

И во-вторых, теперь автодополнение доступно и в скриптах. Взгляните, как это работает!

Данный функционал сравнивать с Postman нет смысла — там автодополнение ограничивается только статическими списками переменных, заголовков и их значений (поправьте меня, если я что забыл). Скрипты не автодополняются :(

Шаг 5. Получение маркера делегированного доступа

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

  1. Выберите папку Делегированные.
  2. Выберите вкладку Авторизация.
  3. В разделе Настройка нового маркера щелкните вкладку Параметры конфигурации. Оставьте предварительно настроенные значения для всех полей, включая Тип предоставления разрешения, для которого задано значение .
  4. Прокрутите страницу вправо и щелкните Получить новый маркер доступа.
  5. Войдите с помощью учетной записи администратора клиента разработчика.
  6. Щелкните Продолжить, а затем Использовать маркер.

Теперь у вас есть действительный маркер доступа для использования в делегированных запросах.

Этапы тестирования API

Каждый тест состоит из тестовых шагов. Это отдельные атомарные действия, которые тест должен выполнять в каждом потоке тестирования API. Для каждого запроса API тест должен будет выполнить следующие действия:

  1. Проверьте корректность кода состояния HTTP. Например, создание ресурса должно возвращать 201 CREATED, а запрещенные запросы должны возвращать 403 FORBIDDEN и т. Д.

  2. Проверьте полезную нагрузку ответа. Проверьте правильность тела JSON, имен, типов и значений полей ответа, в том числе в ответах на ошибочные запросы.

  3. Проверьте заголовки ответа. Заголовки HTTP-сервера влияют как на безопасность, так и на производительность.

  4. Проверьте правильность состояния приложения. Это необязательно и применяется в основном к ручному тестированию или когда пользовательский интерфейс или другой интерфейс можно легко проверить. 

  5. Проверьте базовую работоспособность. Если операция была завершена успешно, но заняла неоправданно много времени, тест не пройден.

Variables¶

All variables can be manually set using the Postman GUI and are scoped.

The code snippets can be used for working with variables in scripts (pre-request, tests).

Learn more about the different variables scopes in this tutorial.

Depending on the closest scope:

Syntax:

Examples:

Request URL:

Headers (key:value):

Request body:

Global variables

General purpose variables, ideal for quick results and prototyping.

Please consider using one of the more specialized variables below. Delete variables once they are no longer needed.

When to use:

passing data to other requests

Setting

pm.globals.set('myVariable', MY_VALUE);

Getting

pm.globals.get('myVariable');

Alternatively, depending on the scope:

pm.variables.get('myVariable');

Removing

Remove one variable

pm.globals.unset('myVariable');

Remove ALL global variables (rather unusual)

pm.globals.clear();

Collection variables

When to use:

  • good alternative to global variables or environment variables
  • for URLs / authentication credentials if only one environment exists

Setting

pm.collectionVariables.set('myVariable', MY_VALUE);

Getting

pm.collectionVariables.get('myVariable');

Removing

pm.collectionVariables.unset('myVariable');

Environment variables

Environment variables are tied to the selected environment. Good alternative to global variables as they have a narrower scope.

When to use:

  • storing environment specific information
  • URLs, authentication credentials
  • passing data to other requests

Setting

pm.environment.set('myVariable', MY_VALUE);

Getting

pm.environment.get('myVariable');

Depending on the closest scope:

pm.variables.get('myVariable');

Removing

Remove one variable

pm.environment.unset("myVariable");

Remove ALL environment variables

pm.environment.clear();

Examples:

pm.environment.set('name', 'John Doe');
console.log(pm.environment.get('name'));
console.log(pm.variables.get('name'));

** Detecting the environment name **

If you need to know inside scripts which environment is currently active (locahost, production, …) you can use the name property:

pm.environment.name

Data variables

Exist only during the execution of an iteration (created by the Collection Runner or Newman).

When to use:

when multiple data-sets are needed

Setting

Can only be set from a CSV or a JSON file.

Getting

pm.iterationData.get('myVariable);

Depending on the closest scope:

pm.variables.get('myVariable');

Removing

Can only be removed from within the CSV or JSON file.

Local variables

Local variables are only available withing the request that has set them or when using Newman / Collection runner during the entire execution.

When to use:

whenever you would like to override all other variable scopes — for whatever reason. Not sure though then this is needed.

Setting

pm.variables.set('myVariable', MY_VALUE);

Getting

pm.variables.get('myVariable', MY_VALUE);

Removing

Local variables are automatically removed once the tests have been executed.

Dynamic variables

All dynamic variables can be combined with strings, in order to generate dynamic / unique data.

Example JSON body:

{"name" "John Doe", "email" "john.doe.{{$timestamp}}@example.com"}

If you want to use dynamic variables in scripts, you can use the replaceIn starting with Postman v7.6.0.

pm.variables.replaceIn('{{$randomFirstName}}'); // returns a String

For more details please see the section dedicated to Dynamic variables

API как соглашение — сначала проверьте спецификацию!

API — это, по сути, соглашение между клиентом и сервером или между двумя приложениями

Перед тем, как начать любое тестирование функциональности, важно убедиться в правильности соглашения. Это можно сделать сначала проверив спецификацию (или само соглашение службы, например, интерфейс Swagger или ссылку OpenAPI) и убедившись, что:

  • эндпоинты правильно именованы; 

  • ресурсы и их типы правильно отражают объектную модель;

  •  нет отсутствующей или дублирующей функциональности; 

  • отношения между ресурсами правильно отражаются в API.

Приведенные выше рекомендации применимы к любому API, но для простоты в этом посте мы предполагаем наиболее широко используемую архитектуру веб-API — REST через HTTP

Если ваш API спроектирован именно как RESTful API, важно убедиться, что контракт REST действителен, включая всю семантику, соглашения и принципы HTTP REST. (описание тут, тут, и здесь). 

Если у вас общедоступный API, ориентированный на клиента, такое тестирование может быть вашим последним шансом убедиться, что все требования соглашения выполнены. После публикации и использования API любые внесенные вами изменения могут внести ошибки в код клиента.(Конечно, когда-нибудь вы сможете опубликовать новую версию API (например, /api/v2 /), но даже в этом случае обратная совместимость скорее всего будет обязательной).

Сохранение ответа на запрос

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

  1. Над окном ответа выберите Сохранить ответ.

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

  2. В верхней части окна приложения укажите имя для примера ответа и выберите Сохранить пример.

Если ваш API-интерфейс содержит дополнительные возможности, продолжайте создание коллекции Postman с дополнительными запросами и ответами.

History

You can access a history of the requests you’ve made in Postman in the History tab on the left of Postman. If you’re signed into a Postman account, your history will sync across devices.

Click a request to open it again. Click + to save the request to a collection. Toggle Save Responses to save request responses so that you can view what was returned by a request when you open it from your history.

The history also includes the collection runs executed. These remain as the summarized version of the run and aren’t logged as single requests. The Save Responses option can’t be used with requests from collection runner.

The View more actions menu allows you to save, monitor, document, or mock a request. Use the delete (trash icon) or Clear all options to remove requests from your history. You can multi-select requests by pressing or and clicking the requests.

Different ways to send the data in a POST Request in Postman

As we discussed earlier, sending a POST request means sending a request with the data wrapped inside the body of the request. There can be different types of data and similarly, there are different ways of sending a data. As you will follow these steps, you will learn in detail about it.

1.Select the method request type as POST in the builder as shown.

As soon as you select the POST request type in Postman you will see that the option Body is enabled which has different options to send the data inside the body. These options are:

  • Form-data
  • X-www-form-urlencoded
  • Raw
  • Binary

Form Data

Form data as the name suggests is used to send the data that you are wrapping inside the form like the details you enter when you fill a form. These details are sent by writing them as KEY-VALUE pairs where the key is the «name» of the entry you are sending and value is it’s value. The following steps will make it clear.

1.Select form-data

  1. Add the following KEY-VALUE pair
  • First name: Harish
  • Last name:  Rajora

Here, first name is the field of some form (text field here) that is needed to be enter and Harish is it’s value i.e. the value the user has entered. Similarly goes for Last name id.

x-www-form-urlencoded

Form data and x-www-form-urlencoded are very similar. They both are used for almost the same purposes. But the difference between the form data and x-www-form-urlencoded is that the url will be encoded when sent through x-www-form-urlencoded. Encoded means the data which is sent will be encoded to different characters so that it is unrecognizable even if it is under attack.

Raw

Raw is the most used part or option while sending the body in the POST method. It is important from the point of view of Postman. Raw means the body message is shown as a stream of bits representing the request body. These bits will be interpreted as a string server.

  1. Click on the dropdown besides binary and there can be seen all the options in which you can send the request

  1. Click on JSON(application/json)

  1. In the editor below copy and paste this

{

«first name»: «Harish»,

«last name»: «Rajora»

}

This is the same data that was sent previously with form-data but instead it is now sent with the JSON format.

Binary

Binary is designed to send the information in a format that cannot be entered manually. Since everything in a computer is converted to binary, we use these options which cannot be written manually such as an image, a file etc. To use this option

1.Click on binary, a CHOOSE FILES option will be available

  1. Choose any file, such as an image file.

Note: If you wish to send to the server some data along with the file then it can also be done in the form-data.

Click on the form-data

Enter file as a key

and you will see a hidden drop-down which says Text as default. You can choose any file format and then select the file from the system.

Always remember what your server is expecting. You cannot send another format than what your server expects, otherwise there will be no response or incorrect response which can obviously be seen by the status code of the response. So now, we have learnt about the POST method and how to use it in Postman. We will move on to the next tutorial now which is Collections.

Exporting and Importing the Collection

While Postman stores our collections in a private, local location, we may want to share the collection. To do that, we export the collection to a JSON file.

The Export command is available within the ellipsis menu of the collection. When prompted for a JSON file version, let’s choose the latest recommended version.

After we select the file version, Postman will prompt for a file name and location for the exported collection. We can choose a folder within our GitHub project, for example.

To import a previously exported collection, we use the Import button. We can find it in the toolbar of the main Postman window. When Postman prompts for a file location, we can navigate to the JSON file we wish to import.

It’s worth noting that Postman does not track exported files. As a result, Postman doesn’t show external changes until we re-import the collection.

How to Parameterize Requests

Data Parameterization is one of the most useful features of Postman. Instead of creating the same requests with different data, you can use variables with parameters. These data can be from a data file or an environment variable. Parameterization helps to avoid repetition of the same tests and iterations can be used for automation testing.

Parameters are created through the use of double curly brackets: `sample`. Let’s take a look at an example of using parameters in our previous request:

Now let’s create a parameterize get request.

Step 1)

  1. Set your HTTP request to GET
  2. Input this link: https://jsonplaceholder.typicode.com/users. Replace the first part of the link with a parameter such as `url`. Request url should now be `url`/users.
  3. Click send.

There should be no response since we have not set the source of our parameter.

Step 2) To use the parameter you need to set the environment

  1. Click the eye icon
  2. Click edit to set the variable to a global environment which can be used in all collections.

Step 3) In variable,

  1. set the name to the url which is https://jsonplaceholder.typicode.com
  2. click Save.

Step 4) Click close if you see the next screen

Step 5) Go back to your Get request then click send. There should now be results for your request.

*Note: Always ensure that your parameters have a source such as an environment variable or data file to avoid errors.

Запуск коллекций через графический интерфейс или через терминал

В предыдущей своей статье я уже упоминал об npm пакете Newman, который позволяет запускать ваши коллекции из консоли, а следовательно это легко интегрировать в ваш CI/CD, предварительно завернув все это в Docker контейнер, дабы восславить богов DevOps-a. Все что вам следует сделать — это установить пакет, а после вызвать его передав файл с коллекцией и переменными окружения. Для этого вам нужно экспортировать данные файлы из Postman.

Экспортирование коллекции и файла переменных окружения

Единственное существенное ограничение, это отсутствие возможности переписывать значение переменных окружения из консоли. Для решения данной проблемы я использую глобальные переменные. Хоть и не лучшее решение, но единственно возможное. Делается это через флаг:

--global-var “<global-variable-name>=<global-variable-value>”

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

Запуск коллекции через Collection runner

Но даже это еще не все. При платной подписке у вас появляется возможность запускать свои коллекции на удаленных серверах с заданной периодичностью. На выбор предоставляется шесть регионов. Отличный выбор для небольших команд, у которых еще нету настроенного CI/CD. Можно не только запускать тесты, но и потестировать скорость отклика для различных регионов.

Человекочитаемый формат проекта

Между TestMace и Postman есть концептуальное различие в способе хранения. В Postman все запросы хранятся где-то в локальном хранилище. Если есть необходимость расшарить запросы между несколькими пользователями, то нужно воспользоваться встроенной синхронизацией. На самом деле это общепринятый подход, не лишенный недостатков. Как насчет безопасности данных? Ведь политика некоторых компаний может не позволять хранить данные у третьих лиц. Однако мы считаем, что TestMace может предложить кое-что получше! И имя этом улучшению — «человекочитаемый формат проекта».

Начнем с того, что в TestMace в принципе есть сущность “проект”. И приложение изначально разрабатывалось с прицелом на хранение проектов в системах контроля версий: дерево проекта практически один в один проецируется на файловую структуру, в качестве формата хранения используется yaml (без лишних скобочек и запятых), а файловое представление каждого узла детально описано в документации с комментариями. Но в большинстве случаев вы туда заглядывать не будете — все имена полей имеют логичные названия.

Как видите, TestMace не навязывает свои экосистему и парадигму. Вместо этого он легко встраивается в уже устоявшиеся процессы.

Примеры запросов

Вот пример тестирования запроса, который получает идентификатор пользователя от сервера, — GET user id.

  1. Создайте коллекцию. Дайте ей имя, например Useridtest. Откройте вкладку для запроса: он будет сохранен в этой коллекции.
  2. Введите URL запроса. Для обучения можно использовать открытую документацию от разработчиков Postman. Для возврата идентификатора пользователя подойдет URL https://postman-echo.com/get?userId=333. Во вкладке Params автоматически появятся параметры запроса — userid.
  3. Выберите метод запроса. Для получения идентификатора пользователя нужен метод GET.
  4. Отправьте запрос. Нажмите кнопку Send — Postman отправит запрос на свой echo-сервер для учебных запросов.
  5. Получите ответ. Программа выведет тело ответа (программный код) в окно Response, а код статуса появится в меню выше. В учебном примере запрос выполнится успешно: код примет значение 200.

Postman

Основное предназначение приложения — создание коллекций с запросами к вашему API. Любой разработчик или тестировщик, открыв коллекцию, сможет с лёгкостью разобраться в работе вашего сервиса. Ко всему прочему, Postman позволяет проектировать дизайн API и создавать на его основе Mock-сервер. Вашим разработчикам больше нет необходимости тратить время на создание «заглушек». Реализацию сервера и клиента можно запустить одновременно. Тестировщики могут писать тесты и производить автоматизированное тестирование прямо из Postman. А инструменты для автоматического документирования по описаниям из ваших коллекций сэкономят время на ещё одну «полезную фичу». Есть кое-что и для администраторов — авторы предусмотрели возможность создания коллекций для мониторинга сервисов.

Вводим несколько запросов для Aeris API в Postman

Теперь давайте посмотрим информацию о погоде из Aeris Weather API, которую изучили . Сконструировать конечную точки для Aeris Weather API немного сложнее, поскольку для конфигурации конечной точки можно использовать много разных запросов, фильтров и других параметров.

Вот несколько предварительно настроенных запросов для настройки для Aeris.

Можно вставить запросы непосредственно в поле запроса URL-адреса в Postman (после настройки значений и ), и параметры будут автоматически заполнены в нужных полях.

Как и в случае OpenWeatherMap API, Aeris API не использует поле заголовка для передачи ключей API — ключ и секрет передаются непосредственно в URL-адресе запроса, как часть строки запроса.

Note: При создании следующих запросов, вставьте свои собственные значения для и (при условии, что вы получили их, выполняя практическое занятие ). При отсутствии и , можно использовать ключи автора.

Получаем прогноз погоды для своего района, используя конечную точку Observations:

Получаем погоду для города на экваторе — Чимборасо, Эквадор, используя ту же точку Observations:

Посмотрим, вся ли музыка кантри в Ноксвилле, штат Теннесси, провоцирует мигрень у жителей, используя конечную точку Indices:

Подумываете о переезде в Аризону и подыскиваете местечко получше? Используем конечную точку normals

Tip: И с OpenWeatherMap, и с Aeris Weather API можно сделать эти запросы, просто перейдя по URL-адресу в адресной строке (поскольку API передаются в строке запроса, а не в заголовке). Используйте расширение JSON Formatter для Chrome, чтобы автоматически форматировать ответ JSON в представлении браузера.

Изучив эти два разных API сервисов прогноза погоды, можно увидеть различия в способе вызова и возврата информации. Однако, по сути, оба API имеют конечные точки, которые можно настраивать с помощью параметров. При создании запроса с конечными точками, получаем ответы, которые содержат информацию, часто в формате JSON. Это основа работы REST API: отправляем запрос — получаем ответ.

Using external libraries

The method allows you to use the sandbox built-in library modules. The list of available libraries is listed below with links to the corresponding documentation.

  • ajv
  • atob
  • btoa
  • chai
  • cheerio
  • crypto-js
  • csv-parse/lib/sync
  • lodash (The built-in object v3.10.1 exists in the sandbox by default. Use to load the latest version.)
  • moment
  • postman-collection
  • tv4
  • uuid
  • xml2js

A number of NodeJS modules are also available to use in the sandbox:

  • path
  • assert
  • buffer
  • util
  • url
  • punycode
  • querystring
  • string-decoder
  • stream
  • timers
  • events

In order to use a library, call the method, pass the module name as a parameter, and assign the return object from the method to a variable.

Postman

Основное предназначение приложения — создание коллекций с запросами к вашему API. Любой разработчик или тестировщик, открыв коллекцию, сможет с лёгкостью разобраться в работе вашего сервиса. Ко всему прочему, Postman позволяет проектировать дизайн API и создавать на его основе Mock-сервер. Вашим разработчикам больше нет необходимости тратить время на создание «заглушек». Реализацию сервера и клиента можно запустить одновременно. Тестировщики могут писать тесты и производить автоматизированное тестирование прямо из Postman. А инструменты для автоматического документирования по описаниям из ваших коллекций сэкономят время на ещё одну «полезную фичу». Есть кое-что и для администраторов — авторы предусмотрели возможность создания коллекций для мониторинга сервисов.

Postman

Основное предназначение приложения — создание коллекций с запросами к вашему API. Любой разработчик или тестировщик, открыв коллекцию, сможет с лёгкостью разобраться в работе вашего сервиса. Ко всему прочему, Postman позволяет проектировать дизайн API и создавать на его основе Mock-сервер. Вашим разработчикам больше нет необходимости тратить время на создание «заглушек». Реализацию сервера и клиента можно запустить одновременно. Тестировщики могут писать тесты и производить автоматизированное тестирование прямо из Postman. А инструменты для автоматического документирования по описаниям из ваших коллекций сэкономят время на ещё одну «полезную фичу». Есть кое-что и для администраторов — авторы предусмотрели возможность создания коллекций для мониторинга сервисов.

Установка Postman

Загрузить Postman для Windows можно на официальном сайте программы. Кроме версии для Windows, здесь есть портативные версии для Linux и MacOS.

После загрузки будет необходимо запустить загруженную программу. В Linux также можно установить программу из центра приложений Ubuntu:

Или с помощью универсального менеджера пакетов snap. Для этого выполните:

После завершения установки postman в Linux можно запускать программу из главного меню.

После первого запуска программа предлагает создать бесплатный аккаунт. Он необходим для синхронизации результатов вашей работы между устройствами. Создайте аккаунт или войдите в уже существующий нажав кнопку Sign In. Для создания аккаунта надо ввести адрес электронной почты, ваш ник, пароль и нажать оранжевую кнопку Create Free Account:

После входа в аккаунт вы попадёте в главное окно программы. Дальше давайте рассмотрим использование Postman, это будет так сказать инструкция для чайников, поэтому если вы уже пользовались программой и всё в ней знаете, то вам будет не интересно.

Рейтинг
( Пока оценок нет )
Понравилась статья? Поделиться с друзьями:
Ваша ОС
Добавить комментарий

;-) :| :x :twisted: :smile: :shock: :sad: :roll: :razz: :oops: :o :mrgreen: :lol: :idea: :grin: :evil: :cry: :cool: :arrow: :???: :?: :!: