Создание Restful API с помощью Flask, Postman и PyTest — часть 2 (время чтения: 10 минут)

Сегодня мы рассмотрим создание фиктивных конечных точек в Postman. Чтобы помочь в разработке и прототипировании конечных точек API для менеджер по расходам проект с использованием Колба а также питест в части 3.

Для тех, кто плохо знаком с этой серией, вы можете перейти к часть 1 чтобы понять объяснение инструментов и библиотек, используемых в этой серии для создания конечных точек API в Flask.

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

Спецификация проекта

менеджер по расходам должны иметь следующие функции для конечных точек API:

• Показать баланс
• Регулировка баланса
• Показать список транзакций
• Отображение сведений об отдельных транзакциях
• Добавить транзакцию
• Обновить конкретную информацию о транзакции
• Удалить транзакцию

Зачем создавать фиктивные API, а не создавать API?

Причина этого в том, чтобы помочь в прототипирование Процесс разработки конечных точек.

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

Использование вашего прототипа для достижения взаимопонимания и взаимопонимания

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

Нарушение зависимости между интерфейсом и сервером

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

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

К счастью, создание фиктивных конечных точек в Postman упростило совместную работу в гораздо более быстром темпе.

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

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

После создания новой учетной записи загрузите приложение postman в свою ОС. Создавать новая коллекция почтальонов под названием Менеджер по расходам. Почтальон коллекция это место для хранения вашего запроса API в postman.

Создание мок-сервера в Postman

Теперь в вашей только что созданной коллекции Postman нажмите на «>» значок и выберите издевается вкладка

Там будет кнопка с надписью создать фиктивный сервер нажмите на эту кнопку, чтобы создать фиктивный сервер, как показано на рисунке ниже.

Выберите настройки по умолчанию и нажмите Создайте кнопку, как показано ниже.

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

Включение среды Postman

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

Щелкните раскрывающийся список с именем Нет среды. Выбирать Менеджер по расходам Окружающая среда.

Выбирать глаз значок, он покажет вам ссылку на фиктивный сервер под локальной переменной среды, называемой URL.

Эта переменная позволяет создавать точки API без необходимости замены URL-адреса каждого запроса, что экономит ваше время.

Создание нового запроса

Теперь приступим к настройке вашего первого запроса в почтальоне. Выберите свою коллекцию «Менеджер расходов» и нажмите кнопку «…», которая находится внизу кнопки со стрелкой.

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

Оттуда введите имя вашего нового запроса под названием Получить список транзакций и сохраните его в коллекцию менеджера расходов.

Редактирование описания запроса

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

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

API Description: Get the list of transactions in the expenses manager

Список запросов API в Postman

В RESTful API есть куча HTTP методы для различных вариантов использования.

Вы можете получить список основанных методов, нажав на кнопку со стрелкой ПОЛУЧИТЬ метод в вашем запросе.

Типы методов запроса API

Вот HTTP методы, которые вы будете использовать для этого проекта менеджера расширений или будущих API, которые вы будете создавать.

Они следуют той же структуре, что и CRUD Функция типичной базы данных.

Они следующие:

• ПОЛУЧИТЬ — Отображает список записей или конкретной записи.
• ПОЧТА — он создает запись.
• ПОМЕЩАТЬ — Обновляет существующую запись или несколько записей в API. Кроме того, он может создавать новые записи, поэтому вам нужно перехватывать любые операции PUT, которые не обновляют существующие записи.
• УДАЛИТЬ — Удаляет существующие записи.

Изменить запрос на получение списка транзакций

Теперь перейдите к Список запросов транзакций и введите следующий URL-адрес.

{{URL}} представляет URL-адрес фиктивного сервера.

Дублируйте запросы API

Дублируйте следующий запрос, показанный на рисунке.

• Получить индивидуальную транзакцию — ПОЛУЧИТЬ
• Создать новую транзакцию — ПОЧТА
• Обновление отдельной транзакции — ПОМЕЩАТЬ
• Удалить отдельную транзакцию — УДАЛИТЬ
• Получить текущий баланс — ПОЛУЧИТЬ
• Обновить текущий баланс — ПОМЕЩАТЬ

Создание примера ответа

Пример ответа — это фиктивный ответ всякий раз, когда вы отправляете HTTP-запрос.

Выберите Получить список транзакций запрос и добавьте новый пример ответа.

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

Замените имя на Успешный ответ и введите текст ответа, показанный ниже.

{
    "balance": 200,
    "transactions": [
        {
            "id": 1,
            "amount": "60",
            "description": "New jeans",
            "type": "expense",
            "inital_balance": 300,
            "current_balance": 240,
            "time": "2019-01-12 09:00:00"
        },
        {
            "id": 2,
            "amount": "40",
            "description": "Lunch at a restaurant",
            "type": "expense",
            "inital_balance": 240,
            "current_balance": 200,
            "time": "2019-01-12 12:00:00"
        },
        {
            "id": 3,
            "amount": "10",
            "description": "Tips",
            "type": "income",
            "inital_balance": 200,
            "current_balance": 210,
            "time": "2019-01-12 16:00:00"
        },
        {
            "id": 4,
            "amount": "10",
            "description": "Weekly bus pass",
            "type": "expense",
            "inital_balance": 210,
            "current_balance": 200,
            "time": "2019-01-12 18:00:00"
        }
    ]
}

Добавить код состояния

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

В статус раскрывающемся списке вы можете выбрать код состояния для примера ответа, который в данном случае 200.

Теперь, когда вы нажимаете на Отправить кнопка на вашем Получить список транзакций запрос.

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

Поздравления вы создали свою первую фиктивную конечную точку!!!

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

я включил Почтальон коллекция для Менеджер расширений. Если вам лень играть с фиктивными конечными точками, не волнуйтесь, я никому не скажу.

Expanses Manager Почтальон Коллекция

Вывод

Я надеюсь, что с вашими новыми навыками создания фиктивных конечных точек в почтальоне. Это может значительно помочь вам уменьшить зависимость между вашим интерфейсом и API, которые вы создаете.

Наконец, вы помните, что добавили описание вашего запроса API?

Ну, все коллекции Postman поставляются с документация по API страница, на которой отображаются все ваши API-запросы а также примеры ответов для каждого API.

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

Итак, почтальон, вы занимались созданием этих документов, не тратя на это свое время.

Страница 2

Опубликовано: 06 января 2019 г.

Для первой части серии из 3 частей о создании Restful API с помощью Flask, Postman и PyTest.

Я расскажу о библиотеках и инструментах, используемых для создания менеджер по расходам проект, основанный на Тестирование приложений Python с помощью Pytest чтобы вы понимали, почему вы можете использовать эти инструменты или библиотеки как часть процесса разработки для разработки API-интерфейсов во Flask.

Принимая во внимание, что во второй части серии я расскажу о Дизайн API менеджера по расходам и насмешливый Конечные точки API в Почтальон.

Наконец, в части 3 мы будем реализовывать API в колба с тестовые случаи построен с использованием Питест.

Путь от разработчика Django до разработчика API

Когда я только начал становиться Джанго разработчик, я изучил основы создания простого веб-сайта с помощью Джанго , SQL База данных и JQuery.

По мере накопления опыта я осознал важность создания одностраничных веб-приложений с использованием интерфейсных фреймворков с Django в качестве серверной части.

Я научился сочетать свое понимание фронтенд-фреймворка из Udacity с Фреймворк Django Rest для разработки API-интерфейсов для внешнего интерфейса, которые будут использоваться для моего внутреннего интерфейса во время моей работы.

Создание API с помощью Flask

Flask — еще один веб-фреймворк на основе Python, который считается перейти к фреймворк для разработки Restful API.

Я наткнулся на несколько статей или источников в freeCodeCamp благодаря своей гибкости и простоте создания API без особых усилий.

Исходя из опыта использования Джанго Рест Фреймворк я довольно скептически относился к нему, когда впервые начал его использовать.

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

По причине отсутствия один конкретный способ в создании API по сравнению с Джанго Рест Фреймворк.

Насмешка и тестирование с использованием Postman

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

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

Но позже я узнал, что можно сломать взаимозависимость проблема внешнего и внутреннего интерфейса из-за использования функции фиктивного сервера Postman.

Преодоление зависимостей API от внешнего интерфейса и внутреннего интерфейса.

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

Принимая во внимание, что для бэкэнд-разработчика они могут сосредоточиться на обеспечении внешнего интерфейса рабочей конечной точкой и поменять ее местами, когда она будет завершена. Дальнейшее сокращение времени доставки для команды разработчиков.

Создание тестовых случаев с помощью PyTest

PyTest — это моя платформа для тестирования на python, поскольку она проста в освоении и имеет меньше шаблонного кода по сравнению с установленной по умолчанию. модульный тест библиотека.

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

Вывод

Я надеюсь, что в первой части серии объясняется, почему использование таких инструментов или библиотек, как Postman и Pytest, может помочь ускорить процесс разработки.

Пожалуйста, следите за обновлениями во 2-й и 3-й частях этой серии, чтобы научить вас создавать фиктивные конечные точки и реализовывать их в Flask с помощью тестовых примеров в Pytest.

Подпишитесь на еженедельную рассылку, только что из печи, по одному байту за раз