mirror of
https://github.com/Floriansylvain/RenewCMS.git
synced 2026-08-19 11:43:22 +02:00
65 lines
2.1 KiB
HTML
65 lines
2.1 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>RenewCMS | Home</title>
|
|
{{.Head}}
|
|
</head>
|
|
<body class="text-dark">
|
|
{{.Navbar}}
|
|
<div class="container mt-3 text-black-50">
|
|
<h1>Implementation</h1>
|
|
<p>How to use headless API</p>
|
|
<div class="mt-5">
|
|
<section>
|
|
<h2>Introduction</h2>
|
|
<p>This documentation explains how to integrate our headless CMS API to retrieve article data via the <code>/article</code>
|
|
route.</p>
|
|
</section>
|
|
<section>
|
|
<h2>/v1/article</h2>
|
|
<p>The <code>{{ .Host }}/v1/article</code> route returns a list of articles in JSON format. Each article has the
|
|
following
|
|
structure:</p>
|
|
<pre>
|
|
<code>[
|
|
{
|
|
"id": 12,
|
|
"title": "This is a article!",
|
|
"body": "<p>?</p>\r\n<p><img src=\"../../static/uploadedImages/649691a8-4f2e-48ca-9abe-27a60621d2e4.png\"
|
|
alt=\"\" width=\"391\" height=\"465\"></p>",
|
|
"created_at": "2024-06-13T15:30:55.3563238+02:00",
|
|
"updated_at": "2024-06-13T15:31:17.5508931+02:00"
|
|
}
|
|
]</code>
|
|
</pre>
|
|
</section>
|
|
<section>
|
|
<h2>/v1/article/{id}</h2>
|
|
<p>The <code>{{ .Host }}/v1/article/{id}</code> route returns a single article in JSON format. The article has the
|
|
following
|
|
structure:</p>
|
|
<pre>
|
|
<code>{
|
|
"id": 12,
|
|
"title": "ravioli",
|
|
"body": "<\p>?<\/p>\r\n<\p><\img src=\"../../static/uploadedImages/649691a8-4f2e-48ca-9abe-27a60621d2e4.png\" alt=\"\"
|
|
width=\"391\" height=\"465\"><\/p>",
|
|
"images": [
|
|
{
|
|
"id": 17,
|
|
"path": "/static/uploadedImages/649691a8-4f2e-48ca-9abe-27a60621d2e4.png",
|
|
"article_id": 0,
|
|
"created_at": "2024-06-13T15:31:09.728359+02:00",
|
|
"updated_at": "2024-06-13T15:31:09.728359+02:00"
|
|
}
|
|
],
|
|
"created_at": "2024-06-13T15:30:55.3563238+02:00",
|
|
"updated_at": "2024-06-13T15:31:17.5508931+02:00"
|
|
}</code>
|
|
</pre>
|
|
</section>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|