Apidog Docs
🇰🇷 한국인
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇰🇷 한국인
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇰🇷 한국인
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
  1. API 문서 게시
  • Apidog 학습 센터
  • 시작하기
    • Apidog 소개
    • Apidog의 기본 개념
    • Apidog 탐색하기
    • 빠른 시작
      • 개요
      • 엔드포인트 생성하기
      • 요청 만들기
      • 어서션 추가하기
      • 테스트 시나리오 생성
      • API 문서 공유
      • 더 알아보기
    • Apidog로 마이그레이션
      • 개요
      • 수동 가져오기
      • 예약 가져오기(데이터 소스 바인딩)
      • 가져오기 옵션
      • 데이터 내보내기
      • 가져오기
        • Postman에서 가져오기
        • OpenAPI Spec 가져오기
        • cURL 가져오기
        • Markdown 가져오기
        • Insomnia에서 가져오기
        • apiDoc에서 가져오기
        • .har 파일 가져오기
        • WSDL 가져오기
  • Mock API 데이터
    • 개요
    • 스마트 목
    • 사용자 지정 목
    • 목 우선순위 순서
    • 목 스크립트
    • 클라우드 목
    • Self-Hosted Runner Mock
    • 목 언어(로케일)
  • 계정 및 환경설정
    • 계정 설정
    • OpenAPI 액세스 토큰 생성
    • 알림
    • 언어 설정
    • 단축키
    • 네트워크 프록시 구성
    • 데이터 백업
    • Apidog 업데이트
    • 계정 삭제
    • 실험적 기능
  • 요청 보내기
    • 개요
    • SSE 디버깅
    • MCP 클라이언트
    • Socket.IO
    • WebSocket
    • Webhook
    • SOAP 또는 WebService
    • GraphQL
    • gRPC
    • 디버깅에 요청 프록시 에이전트 사용
    • 요청 만들기
      • 요청 기록
      • 요청 기본 사항
      • 매개변수 및 본문
      • 요청 헤더
      • 요청 설정
      • 요청 디버그
      • 요청을 엔드포인트로 저장하기
      • HTTP/2
    • 인증 및 권한 부여
      • 개요
      • CA 및 클라이언트 인증서
      • 인증 유형
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk 인증
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • 응답 및 쿠키
      • API 응답 보기
      • 쿠키 관리
      • 개요
  • API 개발 및 디버깅
    • 개요
    • 요청 생성
    • 요청 보내기
    • 디버깅 케이스
    • 테스트 케이스
    • 동적 값
    • 응답 검증
    • 디자인 우선 vs 요청 우선
    • 코드 생성
    • 환경 및 변수
      • 개요
      • 변수 사용하기
      • 환경 관리
    • Vault 시크릿
      • 개요
      • HashiCorp Vault
      • Azure Key Vault
      • AWS Secrets Manager
    • 동적 값 모듈
      • Airline
      • 동물
      • 색상
      • Commerce
      • Company
      • 데이터베이스
      • Datatype
      • 날짜
      • 금융
      • Food
      • Git
      • Hacker
      • Helpers
      • Image
      • Internet
      • Location
      • Lorem
      • 음악
      • Number
      • Person
      • Phone
      • 과학
      • String
      • System
      • Vehicle
      • Word
    • 사전/사후 프로세서
      • 개요
      • 어서션
      • 변수 추출
      • Wait
      • 보안
      • 데이터베이스 작업
        • 개요
        • MySQL
        • MongoDB
        • Redis
        • Oracle Client
      • 스크립트 사용
        • 개요
        • 전처리 스크립트
        • 사후 처리 스크립트
        • Public Scripts
        • Postman 스크립트 참조
        • 다른 프로그래밍 언어 호출하기
        • JS 라이브러리 사용하기
        • 응답 시각화
        • 스크립트 예제
          • 어서션 스크립트
          • 변수 사용하기
          • 요청 수정하기
          • 기타 예시
    • API 디버깅
      • AI Agent Debugger
      • A2A Debugger
  • API 설계
    • 개요
    • 새 API 프로젝트 생성
    • 엔드포인트 기본 사항
    • API 설계 지침
    • 모듈
    • 여러 요청 본문 예시 구성
    • 컴포넌트
    • 공통 필드
    • 전역 매개변수
    • 엔드포인트 변경 이력
    • 댓글
    • 엔드포인트 일괄 관리
    • 사용자 지정 프로토콜 API
    • Spec-first 모드(Beta)
    • 보안 스키마
      • 개요
      • 보안 스키마 생성
      • 보안 스키마 사용
      • 온라인 문서의 보안 스키마
    • 고급 기능
      • 사용자 지정 엔드포인트 필드
      • 연결된 테스트 시나리오
      • 엔드포인트 상태
      • 매개변수 목록의 표시 방식
      • 엔드포인트 고유 식별
    • 스키마
      • 개요
      • 새 스키마 생성
      • 스키마 구축
      • JSON 등에서 스키마 생성
      • oneOf, allOf, anyOf
      • Discriminator 사용하기
  • API 테스트
    • 개요
    • 테스트 시나리오
      • 테스트 시나리오 생성
      • 요청 간 데이터 전달
      • 흐름 제어 조건
      • 엔드포인트 및 엔드포인트 케이스에서 데이터 동기화
      • 다른 프로젝트에서 엔드포인트 및 엔드포인트 케이스 가져오기
      • 테스트 시나리오 내보내기
    • 테스트 보고서
      • 테스트 보고서
    • 테스트 시나리오 실행
      • 테스트 시나리오 실행
      • 테스트 시나리오 일괄 실행
      • 데이터 기반 테스트
      • 공유 테스트 데이터
      • 예약 작업
      • 다른 프로젝트의 API 런타임 환경 관리
    • 테스트 스위트
      • 개요
      • 테스트 스위트 생성
      • 테스트 스위트 오케스트레이션
      • 로컬에서 테스트 스위트 실행
      • CLI를 통해 테스트 스위트 실행
      • 예약 작업
    • API 테스트
      • 통합 테스트
      • 성능 테스트
      • 엔드투엔드 테스트
      • 회귀 테스트
      • 계약 테스트
    • Apidog CLI
      • 개요
      • Apidog CLI 설치 및 실행
      • Apidog CLI 옵션
    • CI/CD
      • 개요
      • Github Actions와 통합
      • Gitlab과 통합
      • Jenkins와 통합하기
      • Git 커밋으로 테스트 트리거하기
  • API 문서 게시
    • 개요
    • 지원되는 API 기술
    • Quick Share
    • API 문서 보기
    • Markdown 문서
    • 문서 사이트 게시
    • 사용자 지정 로그인 페이지
    • 사용자 지정 레이아웃
    • 사용자 지정 CSS, JavaScript, HTML
    • 사용자 지정 도메인
    • AI 기능
    • SEO 설정
    • 고급 설정
      • 문서 검색
      • CORS 프록시
      • Google Analytics 통합
      • 폴더 트리 설정
      • 가시성 설정
      • 문서 URL에 값 임베드하기
    • API 버전
      • 개요
      • API 버전 생성
      • API 버전 게시
      • API 버전별 엔드포인트 공유
  • 브랜치
    • 개요
    • 스프린트 브랜치 생성
    • 브랜치에서 API 테스트하기
    • 브랜치에서 API 설계하기
    • 스프린트 브랜치 병합
    • 스프린트 브랜치 관리
    • AI Branch(베타)
  • AI 기능
    • 개요
    • AI 기능 활성화
    • 테스트 케이스 생성
    • AI로 스키마 수정하기
    • 엔드포인트 규정 준수 검사
    • API 문서 완성도 검사
    • AI 기반 필드 명명
    • 자주 묻는 질문
  • Apidog MCP 서버
    • 개요
    • AI에 Apidog 프로젝트 연결
    • 게시된 문서를 AI에 연결하기
    • OpenAPI 파일을 AI에 연결하기
  • 모범 사례
    • API 서명 처리
    • OAuth 2.0으로 보호되는 API에 접근하기
    • 협업 워크플로
    • 인증 상태 관리
  • 오프라인 공간
    • 개요
  • Apidog Europe
    • Apidog Europe
  • 관리
    • 프로젝트 관리
      • 프로젝트 관리
      • 알림 설정
      • 프로젝트 멤버 관리
      • 프로젝트 리소스
        • 데이터베이스 연결
        • Git 연결
    • 팀 관리
      • 팀 관리
      • 팀 멤버 관리
      • 팀 활동
      • 팀 역할 및 권한
      • 팀 리소스
        • General Runner
        • 팀 변수
        • 요청 프록시 에이전트
      • 실시간 협업
        • 팀 협업
    • 온보딩 체크리스트
      • 기본 개념
      • 온보딩 가이드
    • 조직 관리
      • 조직 관리
      • 조직 역할 및 권한
      • 플랜 관리
        • 조직의 청구 관리자
      • Single Sign-On (SSO)
        • SSO 개요
        • Microsoft Entra ID 구성
        • Okta 구성하기
        • 조직에 대한 SSO 구성
        • 사용자 계정 관리
        • 그룹을 팀에 매핑하기
      • SCIM 프로비저닝
        • SCIM 프로비저닝 소개
        • Microsoft Entra ID
        • Okta
      • 조직 리소스
        • 셀프 호스팅 Runner
  • 청구
    • 개요
    • 크레딧
    • 플랜 업그레이드
    • 대체 결제 방법
    • 구독 관리
    • 유료 팀을 조직으로 이동하기
  • 애드온
    • API Hub
    • Apidog Intellij IDEA 플러그인
    • 브라우저 확장 프로그램
      • Chrome
      • Microsoft Edge
    • 요청 프록시
      • 웹에서의 요청 프록시
      • 공유 문서의 요청 프록시
      • 클라이언트의 요청 프록시
  • 데이터 및 보안
    • 데이터 저장 및 보안
    • 사용자 데이터 개인정보 보호 및 보안
    • 요청 라우팅 및 데이터 보안
  • 참조
    • API 설계 우선 접근 방식
    • Apidog OpenAPI 사양 확장
    • JSONPath
    • XPath
    • 정규 표현식
    • JSON Schema
    • CSV 파일 형식
    • Java 환경 설치
    • Runner 배포 환경
    • Apidog Markdown 구문
    • Apidog Swagger 확장
      • 개요
      • x-apidog-folder
      • x-apidog-status
      • x-apidog-name
      • x-apidog-maintainer
    • Apidog JSON Schema 확장
      • 개요
      • x-apidog-mock
      • x-apidog-orders
      • x-apidog-enum
  • 지원 센터
  1. API 문서 게시

SEO 설정

API 문서의 검색 엔진 가시성을 최적화하여 더 많은 개발자와 사용자를 유치하십시오. Apidog는 문서가 검색 결과에서 더 높은 순위를 얻도록 지원하는 포괄적인 SEO 기능을 제공하여, 잠재 사용자가 API를 더 쉽게 발견할 수 있도록 합니다.
버전 요구 사항
이 SEO 기능을 사용하려면 Apidog 버전이 2.7.15 이상이어야 합니다.
필요에 따라 두 가지 수준에서 SEO 설정을 구성할 수 있습니다.
1.
페이지 수준 SEO 설정: 엔드포인트 문서 또는 Markdown 파일과 같은 개별 페이지의 SEO를 구성합니다.
2.
사이트 전체 SEO 설정: 전체 문서 사이트에 대한 전역 SEO 메타데이터, robots.txt, sitemap.xml, 리디렉션 규칙 및 URL 설정을 구성합니다.

페이지 수준 SEO 설정#

엔드포인트 문서 또는 Markdown 페이지 오른쪽에 있는 SEO Settings 아이콘을 클릭하여 페이지 수준 SEO 설정에 액세스할 수 있습니다.
페이지 수준 SEO 설정.png

구성 옵션#

SEO 설정 패널에서 다음을 구성할 수 있습니다.
URL 슬러그: 현재 페이지의 경로를 정의합니다. 예를 들어 find-by-id로 설정하면 최종 페이지 URL은 https://{your-domain.com}/find-by-id가 됩니다.
메타 제목: 검색 엔진 결과에 표시될 웹페이지의 제목입니다.
메타 설명: 검색 엔진 결과에 표시되는 웹페이지에 대한 간단한 설명입니다.
키워드: 검색 엔진의 이해도를 높이는 데 도움이 되는 키워드입니다.
사용자 지정 메타데이터: JSON 형식으로 추가 <meta> 태그를 추가합니다. 예:
[
  {"name": "robots", "content": "noindex"},
  {"name": "twitter:card", "content": "summary_large_image"}
]
이는 HTML에서 다음과 같이 렌더링됩니다.

사이트 전체 수준 SEO 설정#

온라인 문서 사이트를 게시할 때는 "SEO Settings"로 이동하여 사이트 전체 SEO 구성을 적용하십시오.
CleanShot 2025-12-29 at 17.34.15@2x.png

전역 메타데이터#

이는 문서 사이트의 모든 페이지에 대한 기본 <meta> 태그를 설정합니다. 기본 제공 변수를 사용하여 동적 콘텐츠를 생성할 수 있습니다. 페이지 수준 seo 설정으로 재정의하지 않는 한 모든 페이지는 이 구성을 상속합니다.
전역 메타데이터.png
구성 형식:
유효한 JSON 배열을 사용하십시오. 예:
[
  {"property": "og:title", "content": "{{PAGE_TITLE}} - {{SITE_NAME}}"},
  {"property": "og:description", "content": "{{DESCRIPTION}}"},
  {"property": "og:image", "content": "{{SITE_ICON}}"},
  {"name": "twitter:card", "content": "summary_large_image"},
  {"name": "description", "content": "global description information"},
  {"name": "keywords", "content": "global keywords"}
]
이는 HTML에서 다음과 같이 렌더링됩니다.
지원되는 기본 제공 변수:
다음 기본 제공 변수가 지원되며, 입력 시 content 필드에서 자리 표시자로 사용할 수 있습니다.
변수의미
{{PAGE_TITLE}}현재 페이지의 제목
{{PAGE_URL}}페이지의 전체 URL
{{SITE_NAME}}문서 사이트 이름
{{SITE_ICON}}사이트 아이콘의 URL
{{DESCRIPTION}}기본 페이지 설명
{{KEYWORDS}}기본 페이지 키워드
우선순위:
우선순위
Page-Level SEO Settings (endpoint or Markdown page) > Global Metadata > System defaults

Robots 파일(robots.txt)#

이 파일은 크롤러 동작을 제어하며 https://{your-domain.com}/robots.txt에서 액세스할 수 있습니다.
기본 콘텐츠:
User-Agent: *
Allow: /

Sitemap: {{SITEMAP_URL}}
{{SITEMAP_URL}}은 사이트맵 기능이 활성화된 경우 실제 sitemap.xmlURL로 자동 대체됩니다.
비활성화된 경우 이 줄은 자동으로 제거됩니다.
페이지가 색인 생성되지 않도록 방지하는 방법:
전체 사이트의 색인 생성을 차단
Global Metadata에 다음을 추가하십시오.
{"name": "robots", "content": "noindex"}
또는 루트 수준 robots.txt에 다음을 추가하여 검색 엔진이 사이트를 크롤링하지 못하도록 방지하십시오.
단일 페이지의 색인 생성을 차단
특정 페이지의 Custom Metadata에 다음을 추가하십시오.
{"name": "robots", "content": "noindex"}

Sitemap 파일(sitemap.xml)#

활성화하면 시스템이 사이트의 모든 페이지를 나열하는 sitemap.xml을 자동으로 생성하여 검색 엔진이 더 효과적으로 크롤링하도록 돕습니다. https://{your-domain.com}/sitemap.xml을 통해 사이트맵에 액세스할 수 있습니다.
기본 상태: 활성화됨.
비활성화하면 sitemap.xml은 더 이상 사용할 수 없으며 Sitemap: {{SITEMAP_URL}}도 robots.txt에서 제거됩니다.

문서 리디렉션 규칙#

게시된 문서 URL을 수정하는 경우, 사용자가 이전 URL을 방문할 때 404 오류를 방지하기 위해 리디렉션 규칙을 설정할 수 있습니다.
이미지.png
이전 URL에서 새 URL로 사용자를 자동 전달하도록 여러 리디렉션 규칙을 수동으로 추가할 수 있습니다.
이미지.png

URL 및 슬러그 규칙#

사이트 페이지의 기본 URL 규칙을 보려면 project settings를 클릭하십시오.
이미지.png
페이지에 사용자 지정 슬러그(URL)가 설정되어 있는지 여부에 따라 두 가지 유형의 URL 명명 규칙이 있습니다.
이미지.png
URL Slug가 설정된 경우
시스템은 제공된 슬러그를 액세스 경로로 사용합니다.
예를 들어 Markdown 파일의 슬러그가 api-overview인 경우 주소는 다음과 같습니다.
URL Slug가 비어 있는 경우
팀의 SEO 선호 사항과 문서 워크플로에 가장 적합한 규칙을 선택하십시오.

일반 메타데이터 참조#

메타데이터 참조
[
  {
    "name": "robots",
    "content": "noindex"
  },
  {
    "name": "charset",
    "content": "UTF-8"
  },
  {
    "name": "viewport",
    "content": "width=device-width, initial-scale=1.0"
  },
  {
    "name": "description",
    "content": "Page description"
  },
  {
    "name": "keywords",
    "content": "keyword1, keyword2, keyword3"
  },
  {
    "name": "author",
    "content": "Author Name"
  },
  {
    "name": "googlebot",
    "content": "index, follow"
  },
  {
    "name": "google",
    "content": "notranslate"
  },
  {
    "name": "google-site-verification",
    "content": "verification_token"
  },
  {
    "name": "generator",
    "content": "Mintlify"
  },
  {
    "name": "theme-color",
    "content": "#000000"
  },
  {
    "name": "color-scheme",
    "content": "light dark"
  },
  {
    "name": "format-detection",
    "content": "telephone=no"
  },
  {
    "name": "referrer",
    "content": "origin"
  },
  {
    "name": "refresh",
    "content": "30"
  },
  {
    "name": "rating",
    "content": "general"
  },
  {
    "name": "revisit-after",
    "content": "7 days"
  },
  {
    "name": "language",
    "content": "en"
  },
  {
    "name": "copyright",
    "content": "Copyright 2024"
  },
  {
    "name": "reply-to",
    "content": "email@example.com"
  },
  {
    "name": "distribution",
    "content": "global"
  },
  {
    "name": "coverage",
    "content": "Worldwide"
  },
  {
    "name": "category",
    "content": "Technology"
  },
  {
    "name": "target",
    "content": "all"
  },
  {
    "name": "HandheldFriendly",
    "content": "True"
  },
  {
    "name": "MobileOptimized",
    "content": "320"
  },
  {
    "name": "apple-mobile-web-app-capable",
    "content": "yes"
  },
  {
    "name": "apple-mobile-web-app-status-bar-style",
    "content": "black"
  },
  {
    "name": "apple-mobile-web-app-title",
    "content": "App Title"
  },
  {
    "name": "application-name",
    "content": "App Name"
  },
  {
    "name": "msapplication-TileColor",
    "content": "#000000"
  },
  {
    "name": "msapplication-TileImage",
    "content": "path/to/tile.png"
  },
  {
    "name": "msapplication-config",
    "content": "path/to/browserconfig.xml"
  },
  {
    "name": "og:title",
    "content": "Open Graph Title"
  },
  {
    "name": "og:type",
    "content": "website"
  },
  {
    "name": "og:url",
    "content": "https://example.com"
  },
  {
    "name": "og:image",
    "content": "https://example.com/image.jpg"
  },
  {
    "name": "og:description",
    "content": "Open Graph Description"
  },
  {
    "name": "og:site_name",
    "content": "Site Name"
  },
  {
    "name": "og:locale",
    "content": "en_US"
  },
  {
    "name": "og:video",
    "content": "https://example.com/video.mp4"
  },
  {
    "name": "og:audio",
    "content": "https://example.com/audio.mp3"
  },
  {
    "name": "twitter:card",
    "content": "summary"
  },
  {
    "name": "twitter:site",
    "content": "@username"
  },
  {
    "name": "twitter:creator",
    "content": "@username"
  },
  {
    "name": "twitter:title",
    "content": "Twitter Title"
  },
  {
    "name": "twitter:description",
    "content": "Twitter Description"
  },
  {
    "name": "twitter:image",
    "content": "https://example.com/image.jpg"
  },
  {
    "name": "twitter:image:alt",
    "content": "Image Description"
  },
  {
    "name": "twitter:player",
    "content": "https://example.com/player"
  },
  {
    "name": "twitter:player:width",
    "content": "480"
  },
  {
    "name": "twitter:player:height",
    "content": "480"
  },
  {
    "name": "twitter:app:name:iphone",
    "content": "App Name"
  },
  {
    "name": "twitter:app:id:iphone",
    "content": "12345"
  },
  {
    "name": "twitter:app:url:iphone",
    "content": "app://"
  },
  {
    "name": "article:published_time",
    "content": "2024-01-01T00:00:00+00:00"
  },
  {
    "name": "article:modified_time",
    "content": "2024-01-02T00:00:00+00:00"
  },
  {
    "name": "article:expiration_time",
    "content": "2024-12-31T00:00:00+00:00"
  },
  {
    "name": "article:author",
    "content": "Author Name"
  },
  {
    "name": "article:section",
    "content": "Technology"
  },
  {
    "name": "article:tag",
    "content": "tag1, tag2, tag3"
  },
  {
    "name": "book:author",
    "content": "Author Name"
  },
  {
    "name": "book:isbn",
    "content": "1234567890"
  },
  {
    "name": "book:release_date",
    "content": "2024-01-01"
  },
  {
    "name": "book:tag",
    "content": "tag1, tag2, tag3"
  },
  {
    "name": "profile:first_name",
    "content": "John"
  },
  {
    "name": "profile:last_name",
    "content": "Doe"
  },
  {
    "name": "profile:username",
    "content": "johndoe"
  },
  {
    "name": "profile:gender",
    "content": "male"
  },
  {
    "name": "music:duration",
    "content": "205"
  },
  {
    "name": "music:album",
    "content": "Album Name"
  },
  {
    "name": "music:album:disc",
    "content": "1"
  },
  {
    "name": "music:album:track",
    "content": "1"
  },
  {
    "name": "music:musician",
    "content": "Artist Name"
  },
  {
    "name": "music:song",
    "content": "Song Name"
  },
  {
    "name": "music:song:disc",
    "content": "1"
  },
  {
    "name": "music:song:track",
    "content": "1"
  },
  {
    "name": "video:actor",
    "content": "Actor Name"
  },
  {
    "name": "video:actor:role",
    "content": "Role Name"
  },
  {
    "name": "video:director",
    "content": "Director Name"
  },
  {
    "name": "video:writer",
    "content": "Writer Name"
  },
  {
    "name": "video:duration",
    "content": "120"
  },
  {
    "name": "video:release_date",
    "content": "2024-01-01"
  },
  {
    "name": "video:tag",
    "content": "tag1, tag2, tag3"
  },
  {
    "name": "video:series",
    "content": "Series Name"
  }
]
Modified at 2026-06-09 08:53:32
Previous
AI 기능
Next
문서 검색
Built with