跳转到正文

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 许可证发布。