package yojson

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

Install

Dune Dependency

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

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.2.2.tbz
sha256=9abfad8c9a79d4723ad2f6448e669c1e68dbfc87cc54a1b7c064b0c90912c595
sha512=ac52eae3ca1d3129a7885ca638e6ae5bcfc387598a82cc30d3e4988fd154f1756719c399f96e950d898c79a6dbd4ccc44b6f468bcafbd620e6945a0415b41e0c

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: 29 Jun 2024

README

Yojson: JSON library for OCaml

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

Related tooling

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

  1. seq >= "0.2.2"
  2. ocaml >= "4.02.3"
  3. 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 >= "1.3.2"
  4. archetype
  5. atd >= "2.6.0"
  6. atdgen < "1.9.0" | >= "1.13.0" & < "2.8.0" | >= "2.10.0"
  7. atdgen-runtime >= "2.10.0"
  8. avro-compiler
  9. aws < "1.0.0"
  10. aws-config
  11. aws-s3 >= "1.1.0" & < "4.5.1" | >= "4.8.0"
  12. awsm-codegen
  13. bap-radare2
  14. beluga >= "1.1"
  15. bitcoin >= "3.0"
  16. boulangerie
  17. builder-web >= "0.2.0"
  18. caisar
  19. calculon != "0.5"
  20. calculon-redis-lib
  21. camelot >= "1.3.0"
  22. camels
  23. canary
  24. catala = "0.9.0"
  25. cb-check
  26. cbor != "0.2"
  27. cconv-ppx
  28. colibrics
  29. comby-semantic
  30. commons
  31. containers >= "3.9"
  32. coq-lsp
  33. coq-of-ocaml
  34. coq-serapi >= "8.10.0+0.7.0" & < "8.20.0+0.20.0"
  35. current_docker
  36. current_examples >= "0.4"
  37. current_git
  38. current_github
  39. current_gitlab
  40. current_slack
  41. current_ssh
  42. current_web >= "0.4"
  43. cwe_checker
  44. dap
  45. datakit-ci >= "0.12.3"
  46. daypack-lib
  47. decoders-yojson >= "0.7.0"
  48. deriving-yojson
  49. devkit >= "0.4"
  50. docfd >= "2.1.0"
  51. docker-api >= "0.2.2"
  52. docker_hub
  53. dot-merlin-reader != "4.4~5.0.preview" & < "4.6"
  54. dream
  55. dune-release >= "1.4.0"
  56. earlybird < "1.0.0"
  57. eio_main >= "0.10"
  58. facebook-sdk < "0.3.1"
  59. fiat-p256
  60. fit >= "1.2.0"
  61. forester >= "3.1.0"
  62. frama-c >= "19.0" & < "23.0" | >= "27.0~beta"
  63. fred
  64. frenetic >= "3.2.0"
  65. fstar >= "0.9.3.0-beta1"
  66. gapi-ocaml < "0.3.5" | >= "0.4.3"
  67. gdbprofiler >= "0.2"
  68. gemini
  69. gen-bs >= "0.1.0"
  70. github != "4.0.0"
  71. github-data
  72. gitlab
  73. goblint >= "2.0.0"
  74. goblint-cil >= "1.8.0"
  75. gopcaml-mode-merlin < "0.0.6"
  76. gradescope_submit
  77. graphql < "0.9.0" | >= "0.14.0"
  78. graphql-async >= "0.14.0"
  79. graphql-cohttp >= "0.13.0"
  80. graphql-lwt >= "0.14.0"
  81. graphql_ppx
  82. gremlin
  83. guardian
  84. h2
  85. hacl_x25519
  86. hilite < "0.3.0"
  87. hl_yaml
  88. hockmd
  89. horned_worm
  90. hpack
  91. hsluv
  92. httph
  93. index-bench
  94. iocaml
  95. iocaml-kernel
  96. ip2location
  97. ip2locationio
  98. ip2whois
  99. irmin-bench < "3.0.0"
  100. irmin-graphql >= "2.2.0"
  101. irmin-tezos
  102. jasmin
  103. jhupllib
  104. jose
  105. js_of_ocaml-compiler
  106. json-pointer
  107. json-predicate
  108. jsonrpc < "1.6.0"
  109. jsonschema2atd
  110. jupyter
  111. jupyter-kernel
  112. jwto
  113. kappa-library
  114. karamel
  115. ketrew
  116. kind2
  117. kremlin < "transition"
  118. kubecaml
  119. lablgtk3-extras >= "3.0.1"
  120. lablqt
  121. lambdapi >= "2.0.0"
  122. learn-ocaml
  123. letsencrypt
  124. letters
  125. libsail
  126. linol >= "0.2"
  127. linol-eio
  128. linol-lwt
  129. lockfree >= "0.3.0"
  130. logs-async-reporter >= "1.3"
  131. lsp
  132. melange-json = "1.2.0"
  133. melange-json-native
  134. merlin = "3.0.3" | = "3.8.0" | >= "4.6-412"
  135. merlin-acme
  136. metadb
  137. mezzo
  138. minimal >= "1.1.0"
  139. mirage-crypto-ec
  140. mjson
  141. monorobot
  142. mopsa
  143. morbig >= "0.11.0"
  144. multicore-bench
  145. netml
  146. nloge
  147. nsq >= "0.2.4"
  148. obuilder
  149. ocaml-gist
  150. ocaml-lsp-server
  151. ocaml-protoc-plugin >= "6.1.0"
  152. ocaml-webworker
  153. ocaml_db_model
  154. ocaml_pgsql_model
  155. ocamleditor >= "1.15.2-ocaml414"
  156. ocf
  157. oclaunch < "0.2.1"
  158. ocsigen-start
  159. odoc >= "2.0.0" & < "2.1.1" | >= "2.3.0"
  160. oframl
  161. ogen = "0.1.2"
  162. oidc
  163. ojs-base != "0.2.0"
  164. ojs_base
  165. ometrics < "0.2.0"
  166. opam2web >= "2.0"
  167. openai-gym
  168. openapi
  169. openapi_router
  170. openstellina
  171. opium >= "0.19.0"
  172. oraft
  173. orun
  174. osh
  175. ozulip
  176. pa_ppx
  177. pandoc
  178. pbrt_yojson
  179. pds-reachability >= "0.2.3"
  180. petr4
  181. phylogenetics >= "0.2.0"
  182. piece_rope
  183. pkcs11-driver >= "1.0.0"
  184. plist >= "1.0.0"
  185. podge >= "0.4"
  186. ppx_deriving_protocol < "0.8.1"
  187. ppx_deriving_yojson >= "3.4"
  188. ppx_graphql
  189. ppx_json_types
  190. ppx_protocol_conv = "2.0.0"
  191. ppx_protocol_conv_json = "3.1.3" | >= "5.2.1"
  192. ppx_yojson
  193. ppx_yojson_conv < "v0.13.0"
  194. ppx_yojson_conv_lib
  195. prof_spacetime
  196. qmp >= "0.19.0"
  197. quests
  198. r2pipe
  199. radare2
  200. rdf >= "0.9.0"
  201. records = "0.6.0" | >= "1.0.0"
  202. repr-bench
  203. rpc = "2.2.0"
  204. rpclib >= "6.0.0"
  205. rubytt
  206. rungen
  207. SZXX
  208. safemoney
  209. sail < "0.15"
  210. saturn
  211. saturn_lockfree
  212. satyrographos != "0.0.2.7"
  213. semver2
  214. serde_json
  215. sihl < "0.2.0" | >= "0.3.0~rc2"
  216. sihl-core
  217. slack
  218. slacko < "0.14.1"
  219. slug
  220. smtml >= "0.2.2"
  221. sparrow
  222. sphinxcontrib-ocaml
  223. spotify-web-api
  224. starred_ml
  225. swagger
  226. tdigest < "2.1.0"
  227. telegraml < "2.2.0"
  228. testrunner
  229. textmate-language >= "0.3.4"
  230. textrazor >= "0.1.1"
  231. tezos-context-hash-irmin
  232. themoviedb
  233. tidy_email_sendgrid
  234. timedesc < "0.8.0"
  235. timedesc-json
  236. timere < "0.4.0"
  237. transmission-rpc
  238. u2f
  239. usbmux
  240. user-agent-parser
  241. vecosek
  242. vercel
  243. vscoq-language-server
  244. webauthn
  245. why3find
  246. xapi-rrd >= "1.9.0"
  247. yojson-five >= "2.2.2"
  248. yosqlite
  249. zanuda
  250. zarr

Conflicts

None

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct