本文へ移動

Pretty JSON ミドルウェア ​

Pretty JSON ミドルウェアは、JSON レスポンスボディを「JSON の整形表示」にします。 URL のクエリパラメーターに ?pretty を追加すると、JSON 文字列が整形されます。

js
// GET /
{"project":{"name":"Hono","repository":"https://github.com/honojs/hono"}}

次のようになります。

js
// GET /?pretty
{
  "project": {
    "name": "Hono",
    "repository": "https://github.com/honojs/hono"
  }
}

インポート ​

ts
import { Hono } from 'hono'
import { prettyJSON } from 'hono/pretty-json'

使い方 ​

ts
const app = new Hono()

app.use(prettyJSON()) // With options: prettyJSON({ space: 4 })
app.get('/', (c) => {
  return c.json({ message: 'Hono!' })
})

オプション ​

optional space: number ​

インデントのスペース数。デフォルトは 2 です。

optional query: string ​

整形を適用するクエリパラメーター名。デフォルトは pretty です。

optional force: boolean ​

true にすると、クエリパラメーターに関係なく常に JSON レスポンスを整形します。デフォルトは false です。

MIT ライセンスで公開されています。