마크다운 API

Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-Managed, GitLab Dedicated

HTML로 Markdown 콘텐츠 변환.

APIv4에서만 사용 가능.

필요 인증

  • GitLab 15.3에 소개되었으며 기본적으로 authenticate_markdown_api란 이름의 플래그가 함께 제공됨.
Self-Managed GitLab에서는 기본적으로 이 기능이 활성화되어 있고 인증이 필요함. 인증 필요성을 제거하려면 관리자가 authenticate_markdown_api라는 피처 플래그를 비활성화할 수 있음. GitLab.com에서는 해당 기능이 가능하며, GitLab Dedicated에서도 가능함.

Markdown API로의 모든 API 호출은 인증되어야 함.

임의의 Markdown 문서 렌더링 

POST /markdown
속성 타입 필수 여부 설명
text string 예 렌더링할 Markdown 텍스트
gfm boolean 아니요 GitLab Flavored Markdown을 사용하여 텍스트를 렌더링할지 여부. 기본값은 false
project string 아니요 GitLab Flavored Markdown을 사용하여 참조를 만들 때 project를 context로 사용 
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
  --header "Content-Type:application/json" \
  --data '{"text":"Hello world! :tada:", "gfm":true, "project":"group_example/project_example"}' "https://gitlab.example.com/api/v4/markdown"

응답 예시: 

{ "html": "<p dir=\"auto\">Hello world! <gl-emoji title=\"party popper\" data-name=\"tada\" data-unicode-version=\"6.0\">🎉</gl-emoji></p>" }