typress
An editorial workshop.EN

REST API

公開済みの記事やページを、外部のプログラムから JSON で読むための API です。既定ではオフで、オフの間は /api/ 以下はすべて 404 を返します。管理画面の「設定」→「公開 REST API」でオンにします。

エンドポイント

GET  /api/posts?limit=20&offset=0   # 公開済みの投稿(limit は 1〜100)
GET  /api/posts/:slug               # 投稿 1 件と承認済みコメント
GET  /api/pages/:slug               # 固定ページ 1 件
POST /api/comments                  # コメントを送る

記事や設定を書き換えるエンドポイントはありません。書き込みはコメントの投稿だけです。コメント欄(POST /post/:slug/comment のフォーム送信を含む)もこのスイッチがオンのときだけ動きます。

レスポンスの例

{
  "posts": [
    {
      "id": 1,
      "slug": "hello",
      "title": "Hello",
      "excerpt": "...",
      "publishedAt": "2026-01-01T00:00:00.000Z",
      "thumbnail": {
        "mediaId": 12,
        "url": "https://blog.example.com/media/12",
        "mime": "image/png",
        "width": 1280,
        "height": 720
      },
      "terms": [{ "id": 3, "taxonomy": "category", "slug": "news", "name": "News" }]
    }
  ]
}

レート制限

コメントの投稿は送信元 IP ごとに、まとめて 5 件まで、その後は 10 秒に 1 件まで送れます。読み取りには制限がないので、必要なら nginx の limit_req などで絞ってください。

API とは別に、/feed.xml(RSS)と /sitemap.xml は常に公開されています。