Dotnetnuke(DNN)에서 사용자 정의 REST API 엔드포인트 만들기
회사 개요
DNN REST API 플러그인을 사용하면 DNN 플랫폼 내에서 사용자 정의 API 엔드포인트를 생성하여 외부 시스템이 DNN 기능과 상호 작용할 수 있습니다. 모든 HTTP 메서드를 사용하여 특정 요구 사항을 충족하도록 사용자 정의 API 엔드포인트를 쉽게 구성할 수 있습니다. 이 사용자 가이드는 사용자 정의 API를 설정하고 테스트하는 데 도움이 되는 포괄적인 설명서를 제공합니다.
전제조건: 다운로드 및 설치
- DNN REST API에 대한 사용자 정의 API를 구성하려면 다음을 설치해야 합니다. miniOrange DNN REST API 인증 플러그인 DNN 스토어에서.
- 설치 패키지를 업로드하려면 여기를 클릭하세요. 설정 > 확장 > 확장 설치.
구성 단계
DNN 사용자 정의 API 인증을 위한 단계별 가이드입니다.
1. DNN 페이지에 모듈 추가
- DNN 사이트의 아무 페이지나 열고(편집 모드) 클릭하세요. 모듈을 추가합니다.
- 에 대한 검색 DNN REST API DNN REST API를 클릭합니다. 원하는 페이지에 모듈을 끌어다 놓습니다.
- DNN 사이트에서 DNN REST API 모듈 설치가 완료되었습니다.
2. 사용자 정의 API 만들기
- 로 이동 DNN REST API 설정 탭. 여기에서 DNN REST API 인증 플러그인 대시보드.
- 를 클릭하십시오 API 생성, 사용자 정의 API 생성을 시작합니다.
- API 유형을 선택하세요 사용자 정의 API.
- 다음 세부 사항을 입력하십시오.
- API 이름: API에 고유한 이름을 지정하세요.
- API 방법: 선택 HTTP 요청 방법 드롭 다운에서
- 테이블 이름 : 액세스하려는 테이블을 지정하세요.
- 응답 열: 작업을 수행할 열을 선택합니다.
- 인증 구성(선택 사항): 고급 설정 탭에서는 API 키, 기본 인증, JWT 등 API에 대한 인증 방법을 선택하고 해당 방법에 대해 생성된 인증 앱을 매핑하는 옵션을 찾을 수 있습니다.
- 필터 적용(선택 사항): 필터에 따라 특정 레코드에 액세스할 수 있도록 열에 조건을 적용할 수 있습니다.
이를 구성하려면 조건 열 드롭다운에서 열을 선택한 다음 조건을 적용할 조건 및 URL 매개변수를 선택하면 됩니다.
- 를 클릭하십시오 API를 생성합니다.
- 지금 커스텀 API 섹션에서 생성한 API를 찾을 수 있습니다.
3. 생성된 API 테스트
- API를 테스트하려면 다음을 클릭하세요. Test 옵션 아래의 동작 쓰러지 다.
- 구성된 HTTP 메서드가 있는 API 엔드포인트가 포함된 테스트 팝업이 나타납니다. 헤더에서 매개변수를 전달하거나 필요한 경우 본문에서 데이터를 전달하는 옵션을 찾을 수 있습니다. 그런 다음 클릭하세요. 실행하다.
- 모든 것이 올바르게 구성되면 성공적인 응답이 표시되어 API가 예상대로 작동하고 있음을 확인할 수 있습니다.
- 테스트 팝업 창에서 API 요청에 대한 샘플 요청 및 응답 형식을 참조할 수 있습니다.
이 가이드를 통해 DNN 사이트에 사용자 지정 REST API를 설정하고 생성할 수 있습니다 . DNN REST API 플러그인을 활용하면 DNN REST API를 안전하게 구성, 테스트 및 관리할 수 있습니다.
