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.0.tbz
sha256=9fcb1ff2db58ab259f9228796b0ada4794eae97177b1833371380c4e4f90b15d
sha512=31ab8580e0e4e8a05459fbec2fb9424a3df4cf5aef6df21fc577dbe3d32e81103a632c6a511c4dcf1f51819e88b38d2ce7d6888545bc3f359e69e070f8d2e69c

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: 02 May 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. 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. fit >= "1.2.0"
  59. frama-c < "23.0" | >= "27.0~beta"
  60. fred
  61. frenetic
  62. fstar
  63. gapi-ocaml
  64. gdbprofiler
  65. gemini
  66. gendarme-json
  67. github != "4.0.0"
  68. github-data
  69. gitlab
  70. goblint >= "2.0.0"
  71. goblint-cil >= "1.8.0"
  72. gopcaml-mode-merlin < "0.0.6"
  73. gradescope_submit
  74. graphql < "0.9.0" | >= "0.14.0"
  75. graphql-async >= "0.14.0"
  76. graphql-cohttp >= "0.13.0"
  77. graphql-lwt >= "0.14.0"
  78. graphql_ppx
  79. gremlin
  80. guardian
  81. h2
  82. hacl_x25519
  83. hilite < "0.3.0"
  84. hl_yaml
  85. hockmd
  86. horned_worm
  87. hpack
  88. hsluv
  89. httph
  90. index-bench
  91. ip2location
  92. ip2locationio
  93. irmin-graphql
  94. irmin-tezos
  95. jasmin
  96. jhupllib
  97. jose
  98. js_of_ocaml-compiler
  99. jsonrpc < "1.6.0"
  100. jsonschema
  101. jsonschema2atd
  102. jupyter
  103. jupyter-kernel
  104. jwto
  105. kappa-agents >= "4.1.3"
  106. kappa-binaries >= "4.1.3"
  107. kappa-library
  108. karamel
  109. kind2
  110. kremlin < "transition"
  111. kubecaml
  112. lablgtk3-extras >= "3.0.1"
  113. lambdapi
  114. learn-ocaml
  115. letsencrypt
  116. letters
  117. libsail
  118. linol >= "0.2"
  119. linol-eio
  120. linol-lwt
  121. lockfree >= "0.3.1"
  122. logs-async-reporter >= "1.3"
  123. lsp
  124. melange-json = "1.2.0"
  125. melange-json-native
  126. merlin != "4.5-411"
  127. metadb
  128. mirage-crypto-ec
  129. mjson
  130. monorobot
  131. mopsa
  132. morbig >= "0.11.0"
  133. multicore-bench
  134. mutaml
  135. nloge
  136. nsq
  137. obuilder
  138. ocaml-lsp-server
  139. ocaml-protoc-plugin >= "6.1.0"
  140. ocaml_db_model
  141. ocaml_pgsql_model
  142. ocamleditor >= "1.15.2-ocaml414"
  143. ocf
  144. ocsigen-start
  145. odoc >= "3.0.0"
  146. odoc-driver
  147. oframl
  148. oidc
  149. ojs-base
  150. ojs_base
  151. ometrics < "0.2.0"
  152. openai-gym
  153. openapi < "1.0.0"
  154. openapi_router
  155. openstellina
  156. opium >= "0.19.0"
  157. oraft
  158. orun
  159. osh
  160. ozulip
  161. pa_ppx < "0.19"
  162. pandoc
  163. pbrt_yojson
  164. pds-reachability >= "0.2.3"
  165. petr4
  166. phylogenetics >= "0.2.0"
  167. piece_rope
  168. pkcs11-driver >= "1.0.0"
  169. ppx_deriving_jsonschema
  170. ppx_deriving_yojson
  171. ppx_protocol_conv_json < "5.0.0" | >= "5.2.1"
  172. ppx_yojson
  173. ppx_yojson_conv < "v0.13.0"
  174. ppx_yojson_conv_lib
  175. prof_spacetime
  176. qmp >= "0.19.0"
  177. quests
  178. r2pipe
  179. radare2
  180. rdf < "1.0.0"
  181. records = "0.6.0" | >= "1.0.0"
  182. repr-bench
  183. rpclib
  184. rungen
  185. SZXX
  186. safemoney
  187. sail < "0.15"
  188. saturn
  189. saturn_lockfree
  190. satyrographos != "0.0.2.7"
  191. savvy
  192. semver2
  193. serde_json
  194. sihl < "0.2.0" | >= "0.3.0~rc2"
  195. sihl-core
  196. slack
  197. slug
  198. smaws-lib
  199. smtml
  200. snf_mcp
  201. spotify-web-api
  202. swagger
  203. tdigest < "2.1.0"
  204. textmate-language >= "0.3.4"
  205. textrazor >= "0.1.1"
  206. tezos-context-hash-irmin
  207. tidy_email_sendgrid
  208. timedesc < "0.8.0"
  209. timedesc-json
  210. timere < "0.4.0"
  211. user-agent-parser
  212. vecosek
  213. vercel
  214. vscoq-language-server
  215. wasm_of_ocaml-compiler
  216. webauthn
  217. why3find
  218. xapi-rrd >= "1.9.0"
  219. zanuda
  220. 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