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-2.1.2.tbz
sha256=59f2f1abbfc8a7ccbdbf608894e5c75e8a76006e34899254446f83e200dfb4f9
sha512=309cba7568dec51de20c7ab8df033258c275b8d58b0a36a66b26e673a3bc050cbd7e39ff8fe4796e89263e125bcc21e04dc36a394f3cc201956887eee1fb281a

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: 27 Nov 2023

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 (4)

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

Conflicts

None