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.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

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

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