Markdown API
GitLab v19.5Tier: Free, Premium, Ultimate
Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
요약
이 API를 사용하여 Markdown 콘텐츠를 HTML로 렌더링합니다. 이 API에 대한 모든 요청은 인증을 거쳐야 합니다. 이 기능의 사용 가능 여부는 기능 플래그로 제어됩니다. Markdown 콘텐츠를 HTML로 렌더링합니다.
히스토리
- GitLab 15.3에서
authenticate_markdown_api라는 기능 플래그와 함께 필수 인증이 도입되었습니다. 기본적으로 활성화되어 있습니다.
이 API를 사용하여 Markdown 콘텐츠를 HTML로 렌더링합니다.
이 API에 대한 모든 요청은 인증을 거쳐야 합니다.
Feature flag
이 기능의 사용 가능 여부는 기능 플래그로 제어됩니다. 자세한 내용은 히스토리를 참고합니다. 이 기능은 테스트 용도로 사용할 수 있으나 프로덕션 환경에 사용할 준비는 되지 않았습니다.
Markdown 콘텐츠 렌더링#
Markdown 콘텐츠를 HTML로 렌더링합니다.
POST /markdown
| 속성 | 유형 | 필수 | 설명 |
|---|---|---|---|
text |
string | yes | 렌더링할 Markdown 텍스트 |
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"}' \
--url "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>" }