API – это аббревиатура интерфейса прикладного программирования, который является программным посредником, позволяющим двум приложениям (службам) взаимодействовать друг с другом.
Представьте это как официанта/официантку в ресторане. Это поможет вам получить информацию о вашем заказе и передать ее поварам на кухне. Когда еда будет готова, он пойдет за едой и принесет ее вам.
С технической точки зрения база данных похожа на кухню. API похож на официанта. И вы (клиент) похожи на запрос клиента.
Чтобы создавать API, мы можем делать это разными способами/на разных языках. Но в этом уроке я покажу вам, как это сделать с помощью Java Spring/Tomcat с mvn.
Базой данных, с которой мы взаимодействуем, будет MySQL.
1.Установите MySQL и создайте новую базу данных:
MySQL – это RDMBS с открытым исходным кодом, поэтому не стесняйтесь устанавливать и использовать. Поскольку я использую Ubuntu, руководство по установке вы можете найти по адресу Установка MySQL
После этого вы можете создать свою собственную базу данных, которую в этом сообщении в блоге назовите gamelistapi.
Обратитесь к этому, чтобы узнать, как создать базу данных в MySQL Создайте базу данных .
Для работы с базами данных я часто использую Data Grip (инструмент разработки, созданный Jetbrains). DataGrip поддерживает множество баз данных: MySQL, Oracle, SQL server, Postgres, MariaDB и др..
Официальный сайт Datagrid находится [здесь] [ https://www.jetbrains.com/datagrip/ ]
После создания новой базы данных вы можете открыть Datagrid для взаимодействия с вашей базой данных с помощью SQL-запроса или с помощью графического интерфейса Datagrip.
Создать новое соединение:
Конфигурация для подключения к api списка игр:
2.Настройка среды Java и Maven:
Вам нужно будет установить Java (в настоящее время я использую Java 11, но вы можете использовать Java 8, так как это стабильная версия).
Перейдите на сайт oracle, чтобы загрузить соответствующий установщик java для вашей системы: Java-оракул
После этого установите инструмент maven (используется для создания java-приложения). Пожалуйста, перейдите на официальный сайт загрузки maven для загрузки maven: последняя версия maven
Вам нужно будет настроить глобальную среду для java и среды maven, прежде чем вы сможете использовать java и maven в своем проекте. (Настройка зависит от того, какую операционную систему вы используете)
3.Структура проекта:
В проекте maven у нас будет файл pom: для хранения зависимостей (библиотеки), которые мы будем использовать для нашего проекта)
В папке src/ресурсы мы обычно помещаем базу данных, среду, информацию о конфигурации, используемую для проекта. В этом проекте мы разместили db.properties.
Файл db.properties выглядит следующим образом:
// MySQL properties mysql.driver=com.mysql.cj.jdbc.Driver mysql.url=jdbc:mysql://localhost:3306/gamelistapi?useSSL=false mysql.user=**** mysql.password=***** // Hibernate properties hibernate.show_sql=true hibernate.hbm2ddl.auto=update // C3P0 properties hibernate.c3p0.min_size=5 hibernate.c3p0.max_size=20 hibernate.c3p0.acquire_increment=1 hibernate.c3p0.timeout=1800 hibernate.c3p0.max_statements=150
mysql.driver – это параметр, который мы будем использовать для драйвера jdbc для MySQL. mysql.url – это URL-адрес нашей локальной базы данных. ((((Обычно MySQL использует порт 3306) mysql.пользователь и mysq.пароль вы введете туда своего пользователя и пароль от созданной вами базы данных.
- В пакетах src/main у вас будет исходный код, реализующий api списка игр.
Я расскажу о структуре Spring framework в другом посте в блоге.
- Функции api списка игр будут включать: создание новой игры, обновление игры, получение игровых данных и удаление игры.
4.Создайте api списка игр с помощью maven:
Обычно для запуска проекта из maven вы запускаете “mvn …”
Поскольку в нашем проекте используется tomcat 7, командная строка будет:
mvn tomcat7: бежать
5.Использование api списка игр с почтальоном:
Postman – это бесплатный инструмент для взаимодействия пользователей с API. Вы можете скачать почтальона по этой ссылке: почтальон
Например, если вы хотите получить все игры из API, снимок экрана выглядит так.
Если вы хотите создать новую игру:
Не стесняйтесь получать код с моего github gamelist-api
В следующем посте в блоге я расскажу вам о том, как протестировать эти API с помощью Serenity.
Спасибо вам всем за чтение!:-*
Записи: Если вы чувствуете, что этот блог поможет вам, и хотите выразить признательность, не стесняйтесь заглядывать:
Это поможет мне вносить более ценный контент.
Оригинал: “https://dev.to/cuongld2/create-simple-rest-api-for-practice-automation-testing-md8”