커스텀 에러 매핑 관리

본 장에서는 AnyAPI WebAdmin의 [API] 메뉴에서 커스텀 에러 매핑을 관리하는 방법에 대해 설명합니다.

커스텀 에러 매핑 목록 조회

등록된 커스텀 에러 매핑 목록을 조회할 수 있습니다.

  1. AnyAPI WebAdmin의 메뉴 영역에서 [API] 메뉴를 선택합니다.

  2. API 화면이 열리면 목록에서 특정 API를 클릭합니다.

    figure api list click

  3. 해당 API의 상세 정보 화면이 열리면 [Stages] 영역을 클릭합니다.

    figure api detail stage

  4. [Stages] 영역이 확장되면 목록에서 특정 스테이지를 클릭합니다.

    figure api detail stage list click

  5. 해당 스테이지의 상세 정보 화면이 열리면 [Custom Error Mapping] 영역을 클릭합니다.

    figure custom error mapping

  6. [Custom Error Mapping] 영역이 확장되면 'Custom Error Mapping List Table’에서 등록된 커스텀 에러 매핑 목록을 조회할 수 있습니다. 이때 figure refresh icon 버튼을 클릭하면 새로고침되어 최신 정보를 조회할 수 있습니다.

    figure custom error mapping list

    조회 항목에 대한 설명은 다음과 같습니다.

    항목 설명

    Custom Error Mapping Name

    커스텀 에러 매핑의 이름입니다.

    Gateway Error Code

    게이트웨이의 에러 코드입니다.

    Description

    커스텀 에러 매핑에 대한 설명입니다.

    Created At

    커스텀 에러 매핑이 생성된 날짜와 시간입니다.

    1. 'Search' 입력란에 검색어를 입력하면 모든 조회 항목의 값을 대상으로 검색어가 포함된 목록만 조회할 수 있습니다.

    2. figure filter icon 버튼을 클릭하면 조회 항목마다 입력란이 표시됩니다. 이때 해당 입력란에 검색어를 입력하면 해당 항목의 값을 대상으로 검색어가 포함된 목록만 조회할 수 있습니다.

    3. figure show column icon 버튼을 클릭하면 목록에 표시할 항목을 선택할 수 있습니다. 이때 체크박스가 선택된 항목들은 표시되고, 체크박스가 해제된 항목들은 표시되지 않습니다.

커스텀 에러 매핑 생성

새로운 커스텀 에러 매핑을 생성할 수 있습니다.

  1. AnyAPI WebAdmin의 메뉴 영역에서 [API] 메뉴를 선택합니다.

  2. API 화면이 열리면 목록에서 특정 API를 클릭합니다.

    figure api list click

  3. 해당 API의 상세 정보 화면이 열리면 [Stages] 영역을 클릭합니다.

    figure api detail stage

  4. [Stages] 영역이 확장되면 목록에서 특정 스테이지를 클릭합니다.

    figure api detail stage list click

  5. 해당 스테이지의 상세 정보 화면이 열리면 [Custom Error Mapping] 영역을 클릭합니다.

    figure custom error mapping

  6. [Custom Error Mapping] 영역이 확장되면 figure api create icon 버튼을 클릭합니다.

    figure custom error mapping create button

  7. '커스텀 에러 매핑 생성' 다이얼로그 박스가 열리면 에러 매핑 정보를 설정한 후 figure save icon 버튼을 클릭합니다.

    각 설정 항목에 대한 자세한 설명은 커스텀 에러 매핑 설정 항목을 참고합니다.

    figure custom error mapping create set

  8. '생성 확인' 대화상자가 열리면 [확인] 버튼을 클릭합니다.

커스텀 에러 매핑 상세 정보 조회

커스텀 에러 매핑의 정보를 상세하게 확인할 수 있습니다.

  1. AnyAPI WebAdmin의 메뉴 영역에서 [API] 메뉴를 선택합니다.

  2. API 화면이 열리면 목록에서 특정 API를 클릭합니다.

    figure api list click

  3. 해당 API의 상세 정보 화면이 열리면 [Stages] 영역을 클릭합니다.

    figure api detail stage

  4. [Stages] 영역이 확장되면 목록에서 특정 스테이지를 클릭합니다.

    figure api detail stage list click

  5. 해당 스테이지의 상세 정보 화면이 열리면 [Custom Error Mapping] 영역을 클릭합니다.

    figure custom error mapping

  6. [Custom Error Mapping] 영역이 확장되면 목록에서 상세 정보를 확인할 커스텀 에러 매핑을 클릭합니다.

    figure custom error mapping list click

  7. 해당 커스텀 에러 매핑의 상세 정보 화면이 열리면 원하는 정보를 확인할 수 있습니다.

    figure custom error mapping detail

커스텀 에러 매핑 정보 수정

커스텀 에러 매핑의 설정 정보를 수정할 수 있습니다.

  1. AnyAPI WebAdmin의 메뉴 영역에서 [API] 메뉴를 선택합니다.

  2. API 화면이 열리면 목록에서 특정 API를 클릭합니다.

    figure api list click

  3. 해당 API의 상세 정보 화면이 열리면 [Stages] 영역을 클릭합니다.

    figure api detail stage

  4. [Stages] 영역이 확장되면 목록에서 특정 스테이지를 클릭합니다.

    figure api detail stage list click

  5. 해당 스테이지의 상세 정보 화면이 열리면 [Custom Error Mapping] 영역을 클릭합니다.

    figure custom error mapping

  6. [Custom Error Mapping] 영역이 확장되면 목록에서 정보를 수정할 커스텀 에러 매핑을 클릭합니다.

    figure custom error mapping list click

  7. 해당 커스텀 에러 매핑의 상세 정보 화면이 열리면 figure api edit icon 버튼을 클릭합니다.

    figure custom error mapping edit button

  8. 수정 모드로 전환되면 수정할 항목의 값을 설정한 후 figure save icon 버튼을 클릭합니다.

    각 설정 항목에 대한 자세한 설명은 커스텀 에러 매핑 설정 항목을 참고합니다.

    figure custom error mapping edit set

  9. '수정 확인' 대화상자가 열리면 [확인] 버튼을 클릭합니다.

커스텀 에러 매핑 삭제

사용하지 않는 커스텀 에러 매핑을 삭제할 수 있습니다.

  1. AnyAPI WebAdmin의 메뉴 영역에서 [API] 메뉴를 선택합니다.

  2. API 화면이 열리면 목록에서 특정 API를 클릭합니다.

    figure api list click

  3. 해당 API의 상세 정보 화면이 열리면 [Stages] 영역을 클릭합니다.

    figure api detail stage

  4. [Stages] 영역이 확장되면 목록에서 특정 스테이지를 클릭합니다.

    figure api detail stage list click

  5. 해당 스테이지의 상세 정보 화면이 열리면 [Custom Error Mapping] 영역을 클릭합니다.

    figure custom error mapping

  6. [Custom Error Mapping] 영역이 확장되면 목록에서 삭제할 커스텀 에러 매핑의 체크박스 선택한 후 figure api del icon 버튼을 클릭합니다.

    figure custom error mapping del

  7. '삭제 확인' 대화상자가 열리면 [Yes] 버튼을 클릭합니다.