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

Authors

  1. M
    Martin Jambon

Maintainers

  1. N
    nathan@cryptosense.com
  2. M
    marek@xivilization.net

Sources

yojson-2.0.2.tbz
sha256=876bb6f38af73a84a29438a3da35e4857c60a14556a606525b148c6fdbe5461b
sha512=9e150689a814a64e53e361e336fe826df5a3e3851d1367fda4a001392175c29348de55db0b7d7ba18539dec2cf78198efcb7f41b77a9861763f5aa97c05509ad

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: 09 Aug 2022

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 *)

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. dune >= "2.0"
  4. ocaml >= "4.02.3"

Dev Dependencies (2)

  1. odoc with-doc
  2. alcotest with-test & >= "0.8.5"

  1. 0install >= "2.18"
  2. acgtk
  3. archetype
  4. atd >= "2.6.0"
  5. atdgen >= "1.13.0" & < "2.8.0" | >= "2.10.0"
  6. atdgen-runtime >= "2.10.0"
  7. avro-compiler
  8. aws-config
  9. aws-s3 < "4.5.1" | >= "4.8.0"
  10. awsm-codegen
  11. bap-radare2
  12. beluga >= "1.1"
  13. bitcoin >= "3.0"
  14. boulangerie
  15. builder-web >= "0.2.0"
  16. caisar
  17. calculon != "0.5"
  18. calculon-redis-lib
  19. calculon-web = "0.6"
  20. camelot >= "1.3.0"
  21. camels
  22. canary
  23. catala = "0.9.0"
  24. cb-check
  25. cbor >= "0.3"
  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" & < "8.20.0+0.20.0"
  34. current_docker
  35. current_examples
  36. current_git
  37. current_github
  38. current_gitlab
  39. current_slack
  40. current_ssh
  41. current_web
  42. dap
  43. daypack-lib
  44. dblp-api
  45. decoders-yojson >= "0.7.0"
  46. devkit
  47. docfd >= "2.1.0"
  48. docker-api >= "0.2.2"
  49. docker_hub
  50. dot-merlin-reader < "4.9"
  51. dream
  52. dream-inertia
  53. dune-release >= "1.4.0"
  54. dune_deps_extra
  55. eio_main >= "0.10"
  56. elasticsearch-cli = "0.5"
  57. fiat-p256
  58. frama-c
  59. fred
  60. frenetic
  61. fstar
  62. gapi-ocaml
  63. gdbprofiler
  64. gemini < "0.3.0"
  65. gendarme-json
  66. github != "4.0.0"
  67. github-data
  68. gitlab
  69. goblint >= "2.0.0"
  70. goblint-cil >= "1.8.0"
  71. gopcaml-mode-merlin < "0.0.6"
  72. gradescope_submit
  73. graphql < "0.9.0" | >= "0.14.0"
  74. graphql-async >= "0.14.0"
  75. graphql-cohttp >= "0.13.0"
  76. graphql-lwt >= "0.14.0"
  77. graphql_ppx
  78. gremlin
  79. guardian
  80. h2
  81. hacl_x25519
  82. hilite < "0.3.0"
  83. hl_yaml
  84. hockmd
  85. horned_worm
  86. hpack
  87. hsluv
  88. httph
  89. index-bench
  90. ip2location
  91. ip2locationio
  92. irmin-graphql
  93. irmin-tezos
  94. jasmin
  95. jhupllib
  96. jose
  97. js_of_ocaml-compiler < "6.0.1"
  98. jsonrpc < "1.6.0"
  99. jsonschema
  100. jsonschema2atd
  101. jupyter
  102. jupyter-kernel
  103. jwto
  104. kappa-library
  105. karamel
  106. kind2
  107. kremlin < "transition"
  108. kubecaml
  109. lablgtk3-extras >= "3.0.1"
  110. lambdapi
  111. learn-ocaml
  112. letsencrypt
  113. letters
  114. libsail
  115. linol >= "0.2"
  116. linol-eio
  117. linol-lwt
  118. lockfree >= "0.3.1"
  119. lsp
  120. melange-json = "1.2.0"
  121. melange-json-native
  122. merlin != "4.5-411"
  123. metadb
  124. mirage-crypto-ec
  125. mjson
  126. monorobot
  127. mopsa
  128. morbig >= "0.11.0"
  129. mutaml
  130. nloge
  131. nsq
  132. obuilder
  133. ocaml-lsp-server
  134. ocaml-protoc-plugin >= "6.1.0"
  135. ocaml_db_model
  136. ocaml_pgsql_model
  137. ocf
  138. ocsigen-start
  139. odoc-driver
  140. oframl
  141. oidc
  142. ojs-base
  143. ojs_base
  144. ometrics < "0.2.0"
  145. openai-gym
  146. openapi < "1.0.0"
  147. openapi_router
  148. openstellina
  149. opium >= "0.19.0"
  150. oraft
  151. orun
  152. osh
  153. ozulip
  154. pa_ppx < "0.19"
  155. pandoc
  156. pbrt_yojson
  157. pds-reachability >= "0.2.3"
  158. petr4
  159. phylogenetics >= "0.2.0"
  160. piece_rope
  161. pkcs11-driver >= "1.0.0"
  162. ppx_deriving_jsonschema
  163. ppx_deriving_yojson
  164. ppx_protocol_conv_json < "5.0.0" | >= "5.2.1"
  165. ppx_yojson
  166. ppx_yojson_conv < "v0.13.0"
  167. ppx_yojson_conv_lib
  168. prof_spacetime
  169. qmp >= "0.19.0"
  170. quests
  171. r2pipe
  172. radare2
  173. rdf < "1.0.0"
  174. records = "0.6.0" | >= "1.0.0"
  175. repr-bench
  176. rpclib
  177. rungen
  178. SZXX
  179. safemoney
  180. sail < "0.15"
  181. saturn
  182. saturn_lockfree
  183. satyrographos != "0.0.2.7"
  184. savvy
  185. semver2
  186. sihl < "0.2.0" | >= "0.3.0~rc2"
  187. sihl-core
  188. slack
  189. slug
  190. smaws-lib
  191. smtml
  192. snf_mcp
  193. spotify-web-api
  194. swagger
  195. tdigest < "2.1.0"
  196. textmate-language >= "0.3.4"
  197. textrazor >= "0.1.1"
  198. tezos-context-hash-irmin
  199. tidy_email_sendgrid
  200. timedesc < "0.8.0"
  201. timedesc-json
  202. timere < "0.4.0"
  203. user-agent-parser
  204. vecosek
  205. vercel
  206. vscoq-language-server
  207. webauthn
  208. why3find
  209. xapi-rrd >= "1.9.0"
  210. yojson-bench >= "2.0.2"
  211. zanuda
  212. 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