메소드 관리

본 장에서는 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. 해당 스테이지의 상세 정보 화면이 열리면 [Resources] 영역을 클릭합니다.

    figure api detail resources

  6. [Resources] 영역이 확장되면 [Path] 탭의 목록에서 특정 경로를 클릭합니다.

    figure resources path list click

  7. 해당 경로에 등록된 메소드 목록이 카드뷰 형태로 표시됩니다.

    figure method card

    이때 각 카드에서 제공하는 정보 및 기능은 다음과 같습니다.

    항목 설명

    ①

    메소드 종류입니다.

    ②

    메소드 호출 경로입니다.

    ③

    엔드포인트 타입입니다.

    ④

    엔드포인트 서버의 기본 정보입니다.

    ⑤

    메소드의 상세 정보를 확인 및 수정합니다.

    ⑥

    메소드를 삭제합니다.

    ⑦

    메소드의 동작 여부를 선택합니다.

    선택한 특정 경로에 등록된 메소드 목록 화면이 열리면 토글 버튼을 통해 허용 여부를 설정합니다. 이때 토글 버튼을 'ON’으로 설정하면 메소드가 활성화됩니다.

메소드 생성

새로운 메소드를 생성할 수 있습니다.

  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. 해당 스테이지의 상세 정보 화면이 열리면 [Resources] 영역을 클릭합니다.

    figure api detail resources

  6. [Resources] 영역이 확장되면 [Path] 탭의 목록에서 특정 경로를 클릭합니다.

    figure resources path list click

  7. 해당 경로에 등록된 메소드 목록 화면이 열리면 figure api create icon 버튼을 클릭합니다.

    figure method create

  8. '메소드 생성' 다이얼로그 박스가 열리면 메소드 정보를 설정한 후 figure save icon 버튼을 클릭합니다.

    각 설정 항목에 대한 자세한 설명은 메소드 설정 항목을 참고합니다.

    figure method create 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. 해당 스테이지의 상세 정보 화면이 열리면 [Resources] 영역을 클릭합니다.

    figure api detail resources

  6. [Resources] 영역이 확장되면 [Path] 탭의 목록에서 특정 경로를 클릭합니다.

    figure resources path list click

  7. 해당 경로에 등록된 메소드 목록 화면이 열리면 상세 정보를 확인할 메소드의 figure method set icon 버튼을 클릭합니다.

    figure method detail button click

  8. 해당 메소드의 상세 정보 화면이 열리면 각 영역을 확장하여 원하는 정보를 확인할 수 있습니다.

    figure resource setting main

    각 영역에서 제공하는 정보에 대한 설명은 다음과 같습니다.

    • [Resource Setting] 탭

      리소스의 기본적인 설정 정보를 제공합니다.

      영역 설명

      Resource Detail

      리소스의 기본 정보를 확인합니다.

      CORS

      CORS의 활성화 여부를 확인합니다.

      Dynamic Routing

      동적 라우팅 목록을 확인합니다.

    • [Parameter] 탭

      파리미터 관련 정보를 제공합니다.

      영역 설명

      [Request Parameter] 탭

      리소스 요청에 포함된 파라미터 내용을 관리합니다.

      [Request Body] 탭

      리소스 요청에 포함된 바디 내용을 관리합니다.

      [Response Code] 탭

      리소스 요청에 대한 응답 내용을 관리합니다.

    • [Modulation] 탭

      파라미터 변조 관련 정보를 제공합니다.

      영역 설명

      [Request Modulation] 탭

      리소스 요청에 포함된 파라미터 변조 설정 내용을 관리합니다.

      [Response Modulation] 탭

      리소스 요청에 대한 응답의 파라미터 변조 설정 내용을 관리합니다.

파라미터 관리

요청 파라미터 관리

요청 파라미터의 정보를 조회, 추가, 수정, 삭제할 수 있습니다.

  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. 해당 스테이지의 상세 정보 화면이 열리면 [Resources] 영역을 클릭합니다.

    figure api detail resources

  6. [Resources] 영역이 확장되면 [Path] 탭의 목록에서 특정 경로를 클릭합니다.

    figure resources path list click

  7. 해당 경로에 등록된 메소드 목록 화면이 열리면 특정 메소드의 figure method set icon 버튼을 클릭합니다.

    figure method detail button click

  8. 해당 메소드의 상세 정보 화면이 열리면 [Parameter] > [Request Parameter] 탭으로 이동하여 요청 파라미터의 정보를 확인합니다.

    figure method parameter request parameter

    또한 figure api edit icon 버튼을 클릭하면 수정 모드로 전환되어 요청 파라미터를 추가, 수정, 삭제할 수 있습니다. 수정 모드 상태에서 오른쪽 하단의 figure save icon 버튼을 클릭하면 현재 상태를 저장할 수 있습니다.

    • 추가

      수정 모드에서 figure response header create icon 버튼을 클릭하면 각 항목의 입력란이 활성화되고, 값을 설정한 후 figure response header save icon 버튼을 클릭하면 파라미터가 추가됩니다.

    • 수정

      수정 모드에서 'Actions' 항목의 figure response header edit icon 버튼을 클릭하면 각 항목의 입력란이 활성화되고, 값을 수정한 후 figure response header save icon 버튼을 클릭하면 파라미터가 수정됩니다.

    • 삭제

      수정 모드에서 'Actions' 항목의 figure response header del icon 버튼을 클릭하면 '삭제 확인' 메시지가 표시되고, figure response header save 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. 해당 스테이지의 상세 정보 화면이 열리면 [Resources] 영역을 클릭합니다.

    figure api detail resources

  6. [Resources] 영역이 확장되면 [Path] 탭의 목록에서 특정 경로를 클릭합니다.

    figure resources path list click

  7. 해당 경로에 등록된 메소드 목록 화면이 열리면 특정 메소드의 figure method set icon 버튼을 클릭합니다.

    figure method detail button click

  8. 해당 메소드의 상세 정보 화면이 열리면 [Parameter] > [Request Body] 탭으로 이동하여 요청 바디의 정보를 확인합니다.

    figure method parameter request body

    또한 figure api edit icon 버튼을 클릭하면 수정 모드로 전환되어 요청 바디를 수정할 수 있습니다. 수정 모드 상태에서 오른쪽 하단의 figure save 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. 해당 스테이지의 상세 정보 화면이 열리면 [Resources] 영역을 클릭합니다.

    figure api detail resources

  6. [Resources] 영역이 확장되면 [Path] 탭의 목록에서 특정 경로를 클릭합니다.

    figure resources path list click

  7. 해당 경로에 등록된 메소드 목록 화면이 열리면 특정 메소드의 figure method set icon 버튼을 클릭합니다.

    figure method detail button click

  8. 해당 메소드의 상세 정보 화면이 열리면 [Parameter] > [Response Code] 탭으로 이동하여 응답 코드의 정보를 확인합니다. 이때 figure refresh icon 버튼을 클릭하면 새로고침되어 최신 정보를 조회할 수 있습니다.

    figure method parameter response code

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

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

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

    또한 기능 버튼을 사용하여 응답 코드를 추가, 수정, 삭제할 수 있습니다.

    • 추가

      figure api create icon 버튼을 클릭하면 '응답 코드 생성' 다이얼로그 박스가 열립니다. 이때 응답 코드 정보를 설정한 후 figure save icon 버튼을 클릭합니다.

    • 수정

      응답 코드 목록에서 특정 응답 코드를 클릭하면 상세 정보 화면이 열립니다. 이때 figure api edit icon 버튼을 클릭하여 수정 모드로 전환되면 수정할 항목의 값을 설정한 후 figure save icon 버튼을 클릭합니다.

    • 삭제

      응답 코드 목록에서 삭제할 응답 코드의 체크박스 선택한 후 figure api del 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. 해당 스테이지의 상세 정보 화면이 열리면 [Resources] 영역을 클릭합니다.

    figure api detail resources

  6. [Resources] 영역이 확장되면 [Path] 탭의 목록에서 특정 경로를 클릭합니다.

    figure resources path list click

  7. 해당 경로에 등록된 메소드 목록 화면이 열리면 특정 메소드의 figure method set icon 버튼을 클릭합니다.

    figure method detail button click

  8. 해당 메소드의 상세 정보 화면이 열리면 [Modulation] > [Request Modulation] 탭으로 이동하여 요청 헤더 정보를 확인합니다.

    figure method modulation request modulation

    또한 figure api edit icon 버튼을 클릭하면 수정 모드로 전환되어 요청 헤더를 추가, 수정, 삭제할 수 있습니다. 수정 모드 상태에서 오른쪽 하단의 figure save icon 버튼을 클릭하면 현재 상태를 저장할 수 있습니다.

    • 추가

      수정 모드에서 figure response header create icon 버튼을 클릭하면 각 항목의 입력란이 활성화되고, 값을 설정한 후 figure response header save icon 버튼을 클릭하면 요청 헤더가 추가됩니다.

    • 수정

      수정 모드에서 Actions 항목의 figure response header edit icon 버튼을 클릭하면 각 항목의 입력란이 활성화되고, 값을 수정한 후 figure response header save icon 버튼을 클릭하면 요청 헤더가 수정됩니다.

    • 삭제

      수정 모드에서 Actions 항목의 figure response header del icon 버튼을 클릭하면 '삭제 확인' 메시지가 표시되고, figure response header save 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. 해당 스테이지의 상세 정보 화면이 열리면 [Resources] 영역을 클릭합니다.

    figure api detail resources

  6. [Resources] 영역이 확장되면 [Path] 탭의 목록에서 특정 경로를 클릭합니다.

    figure resources path list click

  7. 해당 경로에 등록된 메소드 목록 화면이 열리면 특정 메소드의 figure method set icon 버튼을 클릭합니다.

    figure method detail button click

  8. 해당 메소드의 상세 정보 화면이 열리면 [Modulation] > [Response Modulation] 탭으로 이동하여 응답 헤더 정보를 확인합니다.

    figure method modulation response modulation

    또한 figure api edit icon 버튼을 클릭하면 수정 모드로 전환되어 응답 헤더를 추가, 수정, 삭제할 수 있습니다. 수정 모드 상태에서 오른쪽 하단의 figure save icon 버튼을 클릭하면 현재 상태를 저장할 수 있습니다.

    • 추가

      수정 모드에서 figure response header create icon 버튼을 클릭하면 각 항목의 입력란이 활성화되고, 값을 설정한 후 figure response header save icon 버튼을 클릭하면 응답 헤더가 추가됩니다.

    • 수정

      수정 모드에서 Actions 항목의 figure response header edit icon 버튼을 클릭하면 각 항목의 입력란이 활성화되고, 값을 수정한 후 figure response header save icon 버튼을 클릭하면 응답 헤더가 수정됩니다.

    • 삭제

      수정 모드에서 Actions 항목의 figure response header del icon 버튼을 클릭하면 '삭제 확인' 메시지가 표시되고, figure response header save 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. 해당 스테이지의 상세 정보 화면이 열리면 [Resources] 영역을 클릭합니다.

    figure api detail resources

  6. [Resources] 영역이 확장되면 [Path] 탭의 목록에서 특정 경로를 클릭합니다.

    figure resources path list click

  7. 해당 경로에 등록된 메소드 목록 화면이 열리면 삭제할 메소드의 figure method del icon 버튼을 클릭합니다.

    figure method del

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