마크다운 API

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

HTML로 마크다운 콘텐츠 변환

APIv4에서만 사용 가능.

필수 인증

자체 관리 GitLab에서는 기본적으로 이 기능이 활성화되며 인증이 필요합니다. 인증을 제거하려면 관리자가 named authenticate_markdown_api라는 기능 플래그를 비활성화할 수 있습니다. GitLab.com에서는 이 기능을 사용할 수 있습니다. GitLab Dedicated에서도 가능합니다.

마크다운 API에 대한 모든 API 호출은 인증되어야 합니다.

임의의 마크다운 문서 렌더링

POST /markdown
속성 타입 필수 설명
text string yes 렌더링할 마크다운 텍스트
gfm boolean no GitLab Flavored Markdown을 사용하여 텍스트 렌더링합니다. 기본값은 false입니다.
project string no GitLab Flavored Markdown을 사용하여 참조를 만들 때 project를 컨텍스트로 사용합니다.
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>" }