API 문서를 완벽하게 만드는 데 많은 시간을 들였을 수 있지만, 검색 엔진에서 관련 키워드를 검색할 때 문서가 결과에 거의 표시되지 않는 경우가 있습니다. 문제는 콘텐츠의 품질이 낮아서가 아니라, 문서 사이트에 필수적인 SEO 최적화가 부족하기 때문입니다.
Apidog에서 발행한 온라인 문서 사이트는 사이트맵 생성, robots 파일 관리, 의미론적 URL, 각 페이지에 대한 사용자 정의 가능한 메타데이터 태그를 포함한 다양한 내장 SEO 최적화 기능을 기본으로 제공합니다. 이 모든 기능은 검색 엔진이 콘텐츠를 효과적으로 크롤링하고 색인화하는 데 중요합니다.
이러한 기본값 외에도 특정 요구에 맞게 SEO 설정을 세부적으로 조정할 수 있습니다. 기능은 페이지 수준 설정과 사이트 수준 설정의 두 가지 수준으로 나뉩니다. 페이지 수준 설정을 사용하면 개별 엔드포인트 또는 마크다운 문서를 최적화할 수 있으며, 사이트 수준 설정은 전체 문서 사이트에 대한 통합 관리를 제공합니다.
자세히 살펴보겠습니다. Apidog 버전이 오래된 경우, 먼저 최신 버전으로 업데이트하는 것을 권장합니다 (아래 다운로드 버튼을 클릭하세요).
Apidog 내에서 페이지 수준 SEO 설정 구성하기
페이지 수준 SEO 설정을 사용하면 각 엔드포인트 또는 마크다운 문서 페이지가 검색 엔진에 표시되는 방식을 최적화할 수 있습니다. 설정이 간단하며 가시성과 클릭률을 크게 향상시킬 수 있습니다.
페이지 수준 SEO 설정 구성 방법
1단계: 최적화하려는 페이지 열기
프로젝트에서 원하는 엔드포인트 또는 마크다운 문서 페이지로 이동합니다.
2단계: SEO 설정 아이콘 클릭
페이지 오른쪽 상단에 있는 SEO Settings 아이콘을 찾습니다. 클릭하여 설정 패널을 엽니다.
3단계: 사용자 정의 URL 슬러그 설정
기본적으로 문서 페이지의 URL은 읽기 어렵거나 SEO 친화적이지 않은 숫자 문자열로 시스템 생성됩니다 (예: https://your-domain.com/5702007m0).
"Find pet by ID" 엔드포인트에 대해 의미 있는 URL 슬러그 "find-pet-by-id"를 입력할 수 있으며, URL은 https://your-domain.com/find-pet-by-id가 됩니다. 이렇게 하면 URL이 더 명확하고 기억하기 쉬워집니다.
4단계: 메타 제목 및 메타 설명 편집
메타 제목: 검색 결과에 표시되는 파란색 제목입니다. 명확하고 키워드가 풍부한 제목은 순위를 개선하고 클릭을 유도합니다.
메타 설명: 이 텍스트는 검색 결과에서 제목 아래에 나타날 수 있습니다. 검색 엔진이 때때로 자동으로 생성하지만, 잘 작성된 설명은 사용자가 페이지 내용을 빠르게 이해하는 데 도움이 됩니다.
5단계: 관련 키워드 추가 (선택 사항)
오늘날 검색 엔진은 메타 키워드에 덜 의존하지만, 추가하면 페이지의 주제를 여전히 나타낼 수 있습니다. 예를 들어, "Find pet by ID" 엔드포인트의 경우 추가할 수 있는 키워드는 다음과 같습니다: pet info, per store endpoint, pet data, REST API
6단계: 사용자 정의 메타데이터 삽입 (고급 옵션)
고급 SEO 제어를 위해 JSON을 사용하여 사용자 정의 메타 태그를 정의할 수 있습니다.
예시:
[ {"name": "robots", "content": "noindex"},
{"property": "og:image", "content": "https://your-domain.com/assets/image.png"}]이 태그들은 HTML에서 표준 <meta> 태그로 렌더링되며, 색인 제어 또는 소셜 미디어 공유 시 페이지 표시 방식을 제어할 수 있습니다.
Apidog 내에서 사이트 수준 SEO 설정하기
단일 페이지 SEO 설정 외에도 Apidog는 전체 문서 사이트에서 메타데이터, 색인 규칙 및 URL 리디렉션을 관리하는 데 도움이 되는 포괄적인 사이트 수준 SEO 구성을 제공합니다.
문서를 게시할 때 다음 경로에서 이러한 설정에 접근할 수 있습니다:
Share Docs → Publish Docs Sites → SEO Settings
1. 글로벌 메타데이터 구성
Global Metadata를 사용하여 모든 문서 페이지에 적용되는 메타 태그를 정의합니다. 이를 통해 일관된 브랜딩을 보장하고 모든 페이지에서 작업을 중복하지 않고 SEO를 개선할 수 있습니다. 글로벌 메타데이터는 다음과 같이 설정할 수 있습니다:
[
{"property": "og:title", "content": "{{PAGE_TITLE}} - {{SITE_NAME}}"}
]다음과 같은 내장 변수를 사용할 수 있습니다:
{{PAGE_TITLE}}{{PAGE_URL}}{{SITE_NAME}}{{SITE_ICON}}{{DESCRIPTION}}{{KEYWORDS}}
⚠️ 우선 순위 규칙: 페이지 수준 SEO 설정은 글로벌 메타데이터를 재정의하고, 이는 시스템 기본값을 재정의합니다.
2. robots.txt 관리
robots.txt 파일은 검색 엔진에게 어떤 페이지를 크롤링할지에 대한 지침을 제공합니다. Apidog는 모든 크롤러가 모든 페이지에 접근하고 사이트맵 파일을 가리키도록 하는 기본 robots.txt를 자동으로 생성합니다.
특정 페이지가 색인화되는 것을 방지하려면 글로벌 메타데이터 또는 페이지 수준 SEO 설정에 {"name": "robots", "content": "noindex"}를 추가하기만 하면 됩니다.
3. sitemap.xml 활성화 또는 비활성화
sitemap.xml 기능은 SEO에 큰 도움이 되므로 기본적으로 활성화되어 있습니다. 이 파일("사이트 맵"이라고도 함)은 사이트의 디렉토리와 같으며 모든 페이지 URL을 나열합니다. 검색 엔진 크롤러는 이를 사용하여 콘텐츠를 체계적이고 효율적으로 색인화합니다. 활성화되면 https://{your-domain.com}/sitemap.xml에서 접근할 수 있습니다.
이 기능을 비활성화해야 하는 경우, 시스템은 사이트맵 생성을 중단하고 robots.txt를 자동으로 업데이트하여 사이트맵 참조를 제거합니다.
4. 404 오류 방지를 위한 문서 리디렉션 규칙 설정
게시된 문서의 URL을 변경하는 경우 (예: SEO 최적화를 위해), 문서 리디렉션 규칙을 사용하여 트래픽과 검색 엔진 순위를 보존하세요. 리디렉션 규칙을 설정하면 이전 URL을 방문하는 사용자가 자동으로 새 URL로 이동됩니다.
리디렉션 설정 방법:
1. SEO 설정 패널의 문서 리디렉션 규칙 섹션으로 이동합니다.
2. 이전 URL과 새 URL을 지정하는 규칙을 추가합니다.
이렇게 하면 사용자와 검색 엔진 모두 404 오류 없이 올바른 페이지로 자동으로 이동됩니다.
Apidog의 URL 명명 전략
URL 설정의 경우, 사용자 정의 URL을 설정했는지 여부에 따라 시스템은 다른 전략을 사용합니다. 설정한 경우 시스템은 사용자의 값을 직접 사용합니다. 예를 들어, api-overview로 설정하면 최종 주소는 https://{your-domain.com}/api-overview가 됩니다.
사용자 정의 URL을 설정하지 않으면 두 가지 자동 생성 규칙이 있습니다:
- 규칙 1: 제목 + ID. 예:
https://{your-domain.com}/SEO-Settings-5702007m0. 이는 의미 정보와 고유성을 결합하여 검색 엔진과 사용자 모두가 페이지를 이해하는 데 도움을 줍니다. - 규칙 2: ID만. 예:
https://{your-domain.com}/5702007m0. 이는 더 간단하지만 설명이 부족합니다.
SEO 관점에서 URL에 키워드를 사용하는 것이 일반적으로 더 나은 선택입니다. 검색 엔진은 페이지 순위를 매길 때 URL 키워드를 고려합니다. 하지만 문서 사이트가 이미 강력한 도메인 권한을 가지고 있다면, 키워드가 풍부하거나 "의미론적"인 URL을 사용하는 것의 중요성은 떨어집니다.
대부분의 웹사이트에서 URL에 키워드를 포함하는 것은 모범 사례입니다. 그러나 더 깔끔한 URL을 선호하거나 문서 구조가 복잡한 경우, 단순화되거나 시스템 생성된 URL을 사용하는 것도 유효한 옵션입니다.
API 문서 SEO 구성을 위한 실용적인 팁
검색 결과에서 API 문서의 가시성을 높이려면 다음 단계별 SEO 모범 사례를 따르세요:
1. 글로벌 SEO 설정부터 시작하기
기본 메타 제목, 설명 및 키워드와 같은 글로벌 메타데이터를 설정하는 것부터 시작하세요. 이렇게 하면 전체 문서 사이트에 걸쳐 일관된 SEO 기반이 마련되어 모든 페이지의 기본 사항이 충족됩니다.
2. 페이지 수준 SEO를 위한 핵심 페이지 우선순위 지정
다음으로, 자주 사용되는 엔드포인트, 온보딩 가이드 또는 퀵스타트 튜토리얼과 같은 가장 중요한 페이지를 식별합니다. 이 페이지들은 가장 많은 트래픽을 유도하려는 페이지입니다.
각 페이지에 대해 다음을 사용자 정의합니다:
- 메타 제목: 명확하고 키워드가 풍부하게 만듭니다.
- 메타 설명: 페이지 내용을 간결하게 요약합니다.
- 키워드: 사용자가 검색할 수 있는 관련 용어를 추가합니다.
3. 올바른 URL 구조 선택
URL 규칙을 설정할 때:
- 팀이 SEO를 중요하게 생각하고 검색 가능성을 개선하고 싶다면 제목 포함 URL (예:
/get-user-data)을 사용합니다. - 단순함을 선호하거나 복잡한 문서 구조를 가지고 있다면 ID만 있는 URL (예:
/123456abc)을 사용합니다.
4. SEO는 장기적인 게임임을 이해하기
완벽한 온페이지 설정에도 불구하고 SEO는 시간이 걸립니다. 검색 순위는 다음에 따라 달라집니다:
- 귀하 사이트의 도메인 권한
- 다른 신뢰할 수 있는 출처의 백링크
- 사용자 참여 및 행동
- 검색 엔진의 크롤링 빈도
즉각적인 결과를 기대하지 마세요. 인내심을 가지세요.
5. 데이터를 기반으로 지속적으로 개선하기
SEO 성능을 정기적으로 모니터링하세요:
- 어떤 페이지가 트래픽을 얻고 어떤 페이지가 얻지 못하는지 확인합니다.
- 사용자로부터 피드백을 수집합니다.
- 더 명확한 콘텐츠와 더 나은 메타데이터로 취약한 페이지를 업데이트합니다.
결론
Apidog는 API 문서가 검색 엔진에서 더 나은 순위를 차지하도록 돕는 포괄적인 SEO 툴킷을 제공합니다. 개별 페이지를 세부적으로 조정하거나 전체 사이트의 SEO 설정을 한 곳에서 관리할 수 있습니다.
주요 기능은 다음과 같습니다:
- 더 깔끔하고 키워드가 풍부한 링크를 위한 사용자 정의 URL
- 더 나은 검색 가시성을 위한 메타 제목 및 설명
- 검색 엔진이 사이트를 크롤링하는 데 도움이 되는 사이트맵 생성
- SEO 가치를 잃지 않고 콘텐츠 업데이트를 관리하는 리디렉션 규칙
작은 페이지 수준 편집을 하든 글로벌 설정을 구성하든, Apidog는 검색을 위해 문서를 최적화하는 데 필요한 모든 것을 갖추고 있습니다.
자세한 내용은 Apidog 도움말 문서의 SEO 설정 섹션을 확인하세요.
검색 엔진 최적화에 대해 더 자세히 알아보려면 다음을 참조하세요: