マークダウンAPI

MarkdownコンテンツをHTMLに変換します。

APIv4でのみ利用可能です。

必須認証

GitLab 15.3 でauthenticate_markdown_apiというフラグで導入されました。デフォルトで有効。

フラグ: セルフマネジメントのGitLabでは、デフォルトでこの機能が有効になっており、認証が必要です。認証の必要性をなくすには、管理者はauthenticate_markdown_apiという機能フラグを無効にすることができます。GitLab.comでは、この機能は利用可能です。

Markdown APIへのAPIコールはすべて認証が必要です。

任意のMarkdownドキュメントのレンダリング

POST /markdown
属性種類必須説明
text文字列です。yesレンダリングするMarkdownテキスト
gfmbooleanいいえGitLab Flavored Markdownを使ってテキストをレンダリングします。デフォルトはfalse
project文字列です。いいえ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>" }