도움말:미디어위키 API

Utolee90 (토론 | 기여)님의 2020년 9월 23일 (수) 21:37 판 (일단 문서 작성합니다.)
(차이) ← 이전 판 | 최신판 (차이) | 다음 판 → (차이)

1 개요

미디어위키는 일반 편집자들을 위한 편집 폼 이외에도 텍스트 기반의 API(Application Programming Interface)를 공개하고, 이를 이용해 편집을 원할하게 할 수 있습니다. 이를 이용해서 CLI 환경에서도 미디어위키 기반의 위키를 편집하거나, 대량으로 문서를 조회하는데 이용할 수 있습니다.

리브레 위키의 경우 이 URL을 통해 미디어위키 API에 접근이 가능합니다.

2 API 실험실

미디어위키 API 실험실 화면

특수:ApiSandbox를 이용하면 미디어위키에서 사용가능한 API를 폼 형식으로 입력이 가능합니다. 우선 선택 가능한 동작(action)을 선택한 뒤, 왼쪽의 action 메뉴를 눌러서 세부 동작을 설정할 수 있습니다. 미디어위키 API에 익숙하지 않아도 API 조작을 쉽게 할 수 있는 도구입니다.

3 사용가능한 동작

사용자가 미디어위키 API에 접근해서 사용가능한 동작은 다음과 같습니다. 일부 동작은 특수한 권한이 있어야 가능합니다.

3.1 일반적인 동작

주소창에 입력하는 것만으로도 수행이 가능한 동작입니다. 이론상 URL에 파라미터를 입력하는 것만으로도 수행가능하지만 상당히 복잡해지므로 프로그래밍 언어를 이용하는 것을 권장합니다.

  • query(내용 검색)

3.2 POST 메소드로만 동작 가능

URL을 직접 입력해서 동작이 불가능합니다. API를 조작하기 위해서는 POSTMAN처럼 GET 이외의 메소드 입력을 지원하는 소프트웨어를 사용하거나 특수:ApiSandbox같은 도구를 이용하셔야 합니다.

  • edit(문서 편집)
  • purge(문서 갱신)

3.3 특수 권한이 있어야 동작 가능

일부 동작들은 특수한 권한이 있어야 동작이 가능합니다.

  • delete(문서 삭제)
  • move(문서 이동)


3.4 미디어위키 쿼리

미디어위키의 기능 중 특정한 조건의 문서들이나 사용자 기여 정보 등을 조회할 때 사용합니다. action=query라고 입력하면 동작을 수행할 수 있습니다.

4 예제

리브레 위키 문서에 존재하는 외부 링크 모두 찾기
API 주소 - /api.php?action=query&format=json&prop=extlinks&titles=%EB%A6%AC%EB%B8%8C%EB%A0%88_%EC%9C%84%ED%82%A4&utf8=1&ellimit=20
조회 결과