Беседа

Базовая модель API

Классификация API

1. Получение информации API: этот тип API не изменяет данные на сервере, а только получает данные, что делает его более удобным для тестирования.

2. Изменение информации API: этот тип API изменяет данные на сервере и может также получать некоторые данные. Его сложнее тестировать, так как необходимо убедиться в корректности изменений.

URL-маршрутизация

URL может содержать параметры и другую информацию, но в рамках текущего проекта это не рассматривается.

В настоящее время проект поддерживает только простые URL (используемые исключительно для маршрутизации) для автоматического тестирования API.

Однако для сложных URL-маршрутов также поддерживается простое воспроизведение тестов.

Заголовки запросов

Содержат информацию о безопасности и среде.

Информация в заголовке запроса определяется стандартом и в основном связана с тестированием прав доступа и переключением ролей на основе cookie.

Параметры данных

Это дополнительные данные, передаваемые в запросе, например, из формы.

Формат абстракции параметров: (ключ: значение).

API-параметры можно классифицировать следующим образом (проект может автоматически создавать соответствующую информацию):

• обязательные параметры, необязательные параметры, n необязательных параметров, среди которых должен быть выбран один;
• int, float, str, bool — базовые типы, list, dict — список и словарь.
• источник пользователя: конкретное содержание этого параметра определяется пользователем, и оно может быть ограниченным или неограниченным. Ограниченное означает, что значения параметра ограничены, а неограниченное означает, что параметр полностью определяется содержимым, предоставленным пользователем, например, содержимое комментария и т. д.;
• связь между API: например, идентификатор статьи, который предоставляется списком статей API, затем детали статьи доступны через идентификатор в списке;
• проверка: параметры используются для проверки безопасности или определяются системой.

Возвращаемое значение (JSON)

Проект в настоящее время поддерживает только проверку API в формате JSON.

Возвращаемые значения можно разделить на следующие категории:

• метаданные (код возврата), потребляемые данные (отображаются в пользовательском интерфейсе и не возвращаются в качестве параметров), данные канала (возвращаются на сервер);
• базовые типы int, float, str, bool, список list и словарь dict.
• параметры проверки, используемые для проверки клиента сервером.

Методы построения модели чёрного ящика API

1. Рассматривать одинаковые запросы URL как один API и предварительно определять, являются ли параметры необходимыми.
2. Сохранять все результаты ответов API, включая коды состояния, и определять действительные и недействительные запросы с помощью логических правил (регулярных выражений).
3. Программа автоматически проверяет дополнительную информацию о параметрах запроса (действительно ли необходимые параметры необходимы, должны ли выбираться несколько необязательных параметров).

Модель чёрной доски

Понимание модели API не может быть полностью определено только на основе истории, возможно, потребуется дополнительная информация или эксперименты. Система генерирует вопросы, требующие дополнительных ответов, и записывает их на «чёрную доску», доступную для просмотра любым субъектом, включая сторонние системы и людей. Система может автоматизировать ответы на вопросы с помощью «вычислений» (см. следующий раздел). Когда любой субъект (сторонняя система или человек) отвечает на вопрос, модель API автоматически обновляется, чтобы достичь цели постоянного уточнения.

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

Алгоритм понимания вычислений

Обзор

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

Основная идея

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

Основное описание

0. Условия: модель должна соответствовать определённым требованиям, прежде чем вызывать этот поток вычислений для понимания.
1. Источник: источник всех пользовательских алгоритмов, то есть итератор класса Source(), используемый для создания записей запросов.
2. Поток вычислений: различные функции, определённые под классом Source, реализуют:
   • упаковку исходной функции;
   • вызов пользовательской функции для реализации некоторых пользовательских методов обработки.
3. Пользовательская функция: обычно обрабатывает одну запись запроса, также обрабатывает модель, конкретные параметры и возвращаемые значения зависят от сценария использования.

Метод построения алгоритма

См. реализацию стандартного алгоритма.