package yojson

  1. Overview
  2. Docs
Yojson is an optimized parsing and printing library for the JSON format

Install 

dune-project
 Dependency

github.com Readme Changelog BSD-3-Clause License Edit opam file Versions (15)

Authors

  1. M
    Martin Jambon

Maintainers

  1. P
    paul-elliot@tarides.com
  2. N
    nathan@tarides.com
  3. M
    marek@tarides.com

Sources

yojson-3.0.0.tbz
sha256=99414da7609b92a02474ef4b49ecda15edc8cbba5229341b124e7e4695c39610
sha512=896d0ea829a36ccadba6628800369c1a3ab9e7c64dbda8b76331889c9db481cd64e137f467481ae80a8dd5fca45d748bfa71f58641806cc1bb1a007f8291789f

Description

Yojson is an optimized parsing and printing library for the JSON format.

ydump is a pretty-printing command-line program provided with the yojson package.

Published: 02 Jun 2025

README

Yojson: JSON library for OCaml

Build Status

This library parses JSON data into a nested OCaml tree data structure.

Library documentation

Currently at https://ocaml-community.github.io/yojson/

Examples

A simple example on how to parse JSON from a string literal.

let json_string = {|
  {"number" : 42,
   "string" : "yes",
   "list": ["for", "sure", 42]}|}
(* val json_string : string *)

let json = Yojson.Safe.from_string json_string
(* val json : Yojson.Safe.t *)

let () = Format.printf "Parsed to %a" Yojson.Safe.pp json

Yojson is a pretty common choice for parsing JSON in OCaml, as such it is the base for a number of tools and libraries that are built on top of it.

  • ppx_deriving_yojson to automatically generate code that converts between Yojson.Safe.t and custom OCaml types
  • ppx_yojson_conv, an alternative to ppx_deriving_yojson from Jane Street with different design decisions
  • atd, generates mapping code from .atd specification files and can be used in multiple languages
  • jsonm is an alternate JSON parser that parses JSON into a stream of items, so the complete data structure does not have to be in memory.

Help wanted

Yojson is developed and maintained by volunteers — users like you. Various issues are in need of attention. If you'd like to contribute, please leave a comment on the issue you're interested in, or create a new issue. Experienced contributors will guide you as needed.

There are many simple ways of making a positive impact. For example, you can...

  • Use the software in your project.
  • Give a demo to your colleagues.
  • Share the passion on your blog.
  • Tweet about what you're doing with Yojson.
  • Report difficulties by creating new issues. We'll triage them.
  • Ask questions on StackOverflow.
  • Answer questions on StackOverflow.
  • Discuss usage on the OCaml forums.
  • Pick a task that's easy for you.

Check out in particular good first time issues and other issues with which we could use some help.

License

Yojson is licensed under the 3-clause BSD license, see LICENSE.md for details.

Dependencies (2)

  1. ocaml >= "4.08"
  2. dune >= "2.7"

Dev Dependencies (2)

  1. odoc with-doc
  2. alcotest with-test & >= "0.8.5"

  1. 0install >= "2.18"
  2. abella >= "2.0.8"
  3. acgtk
  4. anthropic
  5. archetype
  6. atd >= "2.6.0"
  7. atdgen >= "3.0.1"
  8. atdgen-runtime >= "2.10.0"
  9. atdml
  10. avro-compiler
  11. avro-simple
  12. aws-config
  13. aws-s3 < "4.5.1" | >= "4.8.0"
  14. awskit-lwt-unix
  15. awskit-s3
  16. awsm-codegen
  17. awso
  18. awso-common
  19. bap-radare2
  20. bitcoin >= "3.0"
  21. bizowie-api
  22. boulangerie
  23. builder-web >= "0.2.0"
  24. cabal
  25. caisar
  26. calculon
  27. camelot >= "1.4.2"
  28. camels
  29. canary
  30. catala = "0.9.0" | >= "1.0.0~beta" & < "1.2.0"
  31. cb-check
  32. cbor >= "0.3"
  33. chess_com_api
  34. colibrics
  35. comby-semantic
  36. commons
  37. containers >= "3.9"
  38. contract
  39. coq-lsp
  40. coq-of-ocaml
  41. coq-serapi < "8.20.0+0.20.0"
  42. crs >= "0.0.20250705"
  43. current_docker
  44. current_examples
  45. current_git
  46. current_github
  47. current_gitlab
  48. current_slack
  49. current_ssh
  50. current_web
  51. dap
  52. daypack-lib
  53. dblp-api
  54. decoders-yojson >= "0.7.0"
  55. devkit
  56. dnsrobot
  57. docker-api >= "0.2.2"
  58. docker_hub
  59. dot-merlin-reader < "4.9"
  60. dream
  61. dream-inertia
  62. dune-cargo-build
  63. dune-release >= "1.4.0"
  64. dune_deps_extra
  65. ecma-regex
  66. eio_main >= "0.10"
  67. elasticsearch-cli = "0.5"
  68. elpi >= "3.3.1"
  69. fehu < "1.0.0~alpha3"
  70. fiat-p256
  71. fit >= "1.2.0"
  72. forester >= "3.1.0"
  73. frama-c < "23.0" | >= "27.0~beta"
  74. fred
  75. frenetic
  76. fstar
  77. gapi-ocaml
  78. gdbprofiler
  79. gemini
  80. gendarme-json < "0.4.0"
  81. gendarme-yojson
  82. github != "4.0.0"
  83. github-data
  84. github-unix >= "4.5.1"
  85. gitlab
  86. goblint-cil >= "1.8.0"
  87. gopcaml-mode-merlin < "0.0.6"
  88. gradescope_submit
  89. graphql < "0.9.0" | >= "0.14.0"
  90. graphql-async >= "0.14.0"
  91. graphql-cohttp >= "0.13.0"
  92. graphql-lwt >= "0.14.0"
  93. graphql_ppx
  94. gremlin
  95. guardian
  96. h2
  97. hacl_x25519
  98. handlebars-ml
  99. hilite < "0.3.0"
  100. hl_yaml
  101. hockmd
  102. hpack
  103. hsluv
  104. httph
  105. huml
  106. huml-cli
  107. index-bench
  108. ip2location
  109. ip2locationio
  110. ip2whois
  111. irmin-graphql
  112. irmin-tezos
  113. jasmin
  114. jhupllib
  115. jose
  116. js_of_ocaml-compiler
  117. jsonrpc >= "1.23.1"
  118. jsonschema
  119. jsonschema-core
  120. jsonschema2atd
  121. jupyter
  122. jupyter-kernel
  123. jwto
  124. kappa-library < "4.1.3"
  125. karamel
  126. kaun >= "1.0.0~alpha1" & < "1.0.0~alpha3"
  127. kind2 >= "3.0.0"
  128. kremlin < "transition"
  129. kubecaml
  130. lablgtk3-extras >= "3.0.1"
  131. lambdapi
  132. learn-ocaml
  133. letsencrypt < "2.0.0"
  134. letters
  135. libsail
  136. lichess_api
  137. linol >= "0.2" & < "0.10"
  138. linol-eio
  139. linol-lwt
  140. lockfree >= "0.3.1"
  141. logs-async-reporter >= "1.3"
  142. lsp < "1.6.0" | >= "1.23.1"
  143. melange-json = "1.2.0"
  144. melange-json-native
  145. merlin != "4.5-411"
  146. metadb
  147. miaou-core
  148. miaou-driver-web
  149. mirage-crypto-ec
  150. mjson
  151. monorobot
  152. mopsa
  153. multicore-bench
  154. mutaml
  155. nats-client
  156. nats-client-async
  157. neo4j_bolt
  158. nloge
  159. nsq
  160. obuilder
  161. ocaml-ai-sdk
  162. ocaml-lsp-server < "1.10.5" | >= "1.18.0" & != "1.21.0-4.14" & != "1.23.0"
  163. ocaml-protoc-plugin >= "6.1.0"
  164. ocaml_db_model
  165. ocaml_pgsql_model
  166. ocamleditor
  167. ocf >= "1.0.0"
  168. ochre
  169. ocsigen-start
  170. odoc >= "3.0.0"
  171. odoc-driver
  172. oframl
  173. oidc
  174. ojs-base
  175. ojs_base
  176. ometrics < "0.2.0"
  177. opam-check-npm-deps >= "4.1.0"
  178. openai-gym
  179. openapi
  180. openapi_router
  181. opencage
  182. openstellina
  183. opium >= "0.19.0"
  184. oraft
  185. orun
  186. osh
  187. oui
  188. ozulip
  189. pa_ppx < "0.14" | >= "0.19"
  190. pandoc
  191. pbrt_yojson
  192. pds-reachability >= "0.2.3"
  193. pgn_parser
  194. pgn_to_tex
  195. phylogenetics >= "0.2.0"
  196. piece_rope
  197. pkcs11-driver >= "1.0.0"
  198. polymarket
  199. ppx_deriving_jsonschema
  200. ppx_deriving_yojson < "3.6.1"
  201. ppx_protocol_conv_json >= "5.2.1"
  202. ppx_yojson
  203. ppx_yojson_conv_lib
  204. ppxlib-tools >= "0.37.0"
  205. prof_spacetime
  206. pxshot
  207. qdrant
  208. qmp >= "0.19.0"
  209. query-json
  210. quests
  211. r2pipe
  212. radare2
  213. rdf
  214. records >= "1.0.0"
  215. repr-bench
  216. rescriptdep
  217. rfsm >= "2.2"
  218. rocq-devtools
  219. rpclib
  220. rungen
  221. rust-staticlib-gen
  222. SZXX
  223. safemoney
  224. saga
  225. sail < "0.15"
  226. saturn
  227. saturn_lockfree
  228. satyrographos >= "0.0.2.8" & < "0.0.2.13"
  229. savvy
  230. semver2
  231. serde_json
  232. server-reason-react >= "0.4.0"
  233. shakuhachi
  234. sihl < "0.2.0" | >= "0.3.0~rc2"
  235. sihl-core
  236. simple_httpd
  237. slack
  238. slug
  239. smaws-lib
  240. smtml >= "0.7.0"
  241. snf_mcp < "0.2.1"
  242. spectrum_palette_ppx
  243. spotify-web-api
  244. starred_ml
  245. swagger
  246. talon < "1.0.0~alpha3"
  247. tdigest < "2.1.0"
  248. testcontainers
  249. textmate-language >= "0.3.4"
  250. textrazor >= "0.1.1"
  251. tidy_email_sendgrid
  252. timedesc < "0.8.0"
  253. timedesc-json
  254. timere < "0.4.0"
  255. transom
  256. user-agent-parser
  257. vecosek
  258. vercel
  259. volgo-vcs >= "0.0.22"
  260. vscoq-language-server < "2.3.3"
  261. vsrocq-language-server
  262. wasm_of_ocaml-compiler
  263. webauthn
  264. why3find
  265. xapi-rrd >= "1.9.0"
  266. yojson-five >= "3.0.0"
  267. yosqlite >= "0.2"
  268. yultracer
  269. zanuda
  270. zarr

Conflicts

None