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.0.tbz
sha256=bfdc33bef3141bba9a8fa66a885b54b29f6bfab450040884dd8cf7cdec784519
sha512=0854d8ab094c8f70fdb6af7f36cac621cecfcbae4592f6e079945761460625fdb7d1bff458998dc95970990daefce57b7f4f9458fd1347a393a1d76709bc9561

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: 03 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. dblp-api
  48. decoders-yojson >= "0.7.0"
  49. deriving-yojson
  50. devkit >= "0.4"
  51. docfd >= "2.1.0"
  52. docker-api >= "0.2.2"
  53. docker_hub
  54. dot-merlin-reader != "4.4~5.0.preview" & < "4.6"
  55. dream
  56. dune-release >= "1.4.0"
  57. earlybird < "1.0.0"
  58. eio_main >= "0.10"
  59. facebook-sdk < "0.3.1"
  60. fiat-p256
  61. fit >= "1.2.0"
  62. forester >= "3.1.0"
  63. frama-c >= "19.0" & < "23.0" | >= "27.0~beta"
  64. fred
  65. frenetic >= "3.2.0"
  66. fstar >= "0.9.3.0-beta1"
  67. gapi-ocaml < "0.3.5" | >= "0.4.3"
  68. gdbprofiler >= "0.2"
  69. gemini
  70. gen-bs >= "0.1.0"
  71. github != "4.0.0"
  72. github-data
  73. gitlab
  74. goblint >= "2.0.0"
  75. goblint-cil >= "1.8.0"
  76. gopcaml-mode-merlin < "0.0.6"
  77. gradescope_submit
  78. graphql < "0.9.0" | >= "0.14.0"
  79. graphql-async >= "0.14.0"
  80. graphql-cohttp >= "0.13.0"
  81. graphql-lwt >= "0.14.0"
  82. graphql_ppx
  83. gremlin
  84. guardian
  85. h2
  86. hacl_x25519
  87. hilite < "0.3.0"
  88. hl_yaml
  89. hockmd
  90. horned_worm
  91. hpack
  92. hsluv
  93. httph
  94. index-bench
  95. iocaml
  96. iocaml-kernel
  97. ip2location
  98. ip2locationio
  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. mutaml >= "0.2"
  146. netml
  147. nloge
  148. nsq >= "0.2.4"
  149. obuilder
  150. ocaml-gist
  151. ocaml-lsp-server
  152. ocaml-protoc-plugin >= "6.1.0"
  153. ocaml-webworker
  154. ocaml_db_model
  155. ocaml_pgsql_model
  156. ocamleditor >= "1.15.2-ocaml414"
  157. ocf
  158. oclaunch < "0.2.1"
  159. ocsigen-start
  160. odoc >= "2.0.0" & < "2.1.1" | >= "2.3.0"
  161. oframl
  162. ogen = "0.1.2"
  163. oidc
  164. ojs-base != "0.2.0"
  165. ojs_base
  166. ometrics < "0.2.0"
  167. opam2web >= "2.0"
  168. openai-gym
  169. openapi
  170. openapi_router
  171. openstellina
  172. opium >= "0.19.0"
  173. oraft
  174. orun
  175. osh
  176. ozulip
  177. pa_ppx
  178. pandoc
  179. pbrt_yojson
  180. pds-reachability >= "0.2.3"
  181. petr4
  182. phylogenetics >= "0.2.0"
  183. piece_rope
  184. pkcs11-driver >= "1.0.0"
  185. plist >= "1.0.0"
  186. podge >= "0.4"
  187. ppx_deriving_jsonschema
  188. ppx_deriving_protocol < "0.8.1"
  189. ppx_deriving_yojson >= "3.4"
  190. ppx_graphql
  191. ppx_json_types
  192. ppx_protocol_conv = "2.0.0"
  193. ppx_protocol_conv_json = "3.1.3" | >= "5.2.1"
  194. ppx_yojson
  195. ppx_yojson_conv < "v0.13.0"
  196. ppx_yojson_conv_lib
  197. prof_spacetime
  198. qmp >= "0.19.0"
  199. quests
  200. r2pipe
  201. radare2
  202. rdf >= "0.9.0"
  203. records = "0.6.0" | >= "1.0.0"
  204. repr-bench
  205. rpc = "2.2.0"
  206. rpclib >= "6.0.0"
  207. rubytt
  208. rungen
  209. SZXX
  210. safemoney
  211. sail < "0.15"
  212. saturn
  213. saturn_lockfree
  214. satyrographos != "0.0.2.7"
  215. semver2
  216. serde_json
  217. sihl < "0.2.0" | >= "0.3.0~rc2"
  218. sihl-core
  219. slack
  220. slacko < "0.14.1"
  221. slug
  222. smtml >= "0.2.2"
  223. sparrow
  224. sphinxcontrib-ocaml
  225. spotify-web-api
  226. starred_ml
  227. swagger
  228. tdigest < "2.1.0"
  229. telegraml < "2.2.0"
  230. testrunner
  231. textmate-language >= "0.3.4"
  232. textrazor >= "0.1.1"
  233. tezos-context-hash-irmin
  234. themoviedb
  235. tidy_email_sendgrid
  236. timedesc < "0.8.0"
  237. timedesc-json
  238. timere < "0.4.0"
  239. transmission-rpc
  240. u2f
  241. usbmux
  242. user-agent-parser
  243. vecosek
  244. vercel
  245. vscoq-language-server
  246. webauthn
  247. why3find
  248. xapi-rrd >= "1.9.0"
  249. yojson-five < "2.2.1"
  250. yosqlite >= "0.2"
  251. zanuda
  252. 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