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

Conflicts

None