Создание пользовательских REST API-интерфейсов в Dotnetnuke (DNN)
Обзор
Плагин DNN REST API позволяет создавать пользовательские конечные точки API в рамках платформы DNN, обеспечивая взаимодействие внешних систем с функциональными возможностями DNN. Вы можете легко настроить свои пользовательские конечные точки API в соответствии с конкретными требованиями, используя все методы HTTP. Данное руководство пользователя содержит подробную документацию, которая поможет вам настроить и протестировать пользовательские API.
Предварительные условия: Загрузка и установка.
- Для настройки пользовательских API для REST API DNN вам потребуется установить... плагин аутентификации miniOrange DNN REST API из магазина DNN.
- Загрузите установочный пакет, перейдя по ссылке: Настройки > Расширения > Установить расширение.
Шаги настройки
Пошаговое руководство по аутентификации с помощью пользовательского API DNN.
1. Добавьте модуль на страницу DNN.
- Откройте любую страницу на вашем сайте DNN (в режиме редактирования) и нажмите на Добавить модуль.
- Найдите DNN REST API и нажмите на DNN REST API. Перетащите модуль на страницу в нужное место.
- Установка модуля DNN REST API на вашем сайте DNN завершена.
2. Создание пользовательских API
- Перейдите в Вкладка «Настройки REST API DNN». Здесь вы увидите Панель управления плагина аутентификации DNN REST API.
- Нажмите на Создать API, для инициализации генерации пользовательского API.
- Выберите тип API как Пользовательский API.
- Введите следующие данные:
- Имя API: Укажите уникальное имя для вашего API.
- Метод API: Выбрать Метод HTTP-запроса из выпадающего списка.
- Название таблицы: Укажите таблицу, к которой хотите получить доступ.
- Столбец ответов: Выберите столбцы, над которыми вы хотите выполнить операции.
- Настройка аутентификации (необязательно): На вкладке «Расширенные настройки» вы найдете опцию выбора методов аутентификации для API, включая ключ API, базовую аутентификацию, JWT и т. д., а также сможете сопоставить приложение аутентификации, созданное для соответствующего метода.
- Применить фильтры (необязательно): Вы можете применять условия к столбцам, что позволит вам получать доступ к определенным записям на основе примененных фильтров.
Для настройки выберите столбец из раскрывающегося списка «Условие», а затем выберите условие и параметр URL, к которым вы хотите применить условие.
- Нажмите на Сгенерировать API.
- Теперь под Пользовательские API В этом разделе вы можете найти созданный вами API.
3. Протестируйте сгенерированные API.
- Чтобы протестировать API, нажмите на Тест вариант под Экшн падать.
- Появится всплывающее окно с тестовой информацией, содержащее вашу конечную точку API с настроенным методом HTTP. Вы можете выбрать передачу параметров в заголовках или, при необходимости, передачу данных в теле запроса. Затем нажмите на кнопку. Выполнить.
- Если все настроено правильно, вы увидите успешный ответ, подтверждающий, что ваш API работает должным образом.
- В окне тестирования вы можете ознакомиться с примерами форматов запросов и ответов для вашего API-запроса.
Это руководство поможет вам настроить и создать собственные REST API для вашего сайта на DNN. Используя плагин DNN REST API, вы сможете безопасно настраивать, тестировать и управлять REST API DNN.
