book

JSON at Work

Name: JSON at Work
Author: Tom Marrs
ISBN: 9781449358327

by Tom Marrs

July 2017

Beginner to intermediate

374 pages

7h 12m

English

O'Reilly Media, Inc.

Read now

Unlock full access

Preface
Audience, Assumptions, and ApproachWhat Does “At Work” Mean?What You’ll LearnWhat You’ll Work WithWho This Book Is Not ForOrganizationPart I, JSON Overview and PlatformsPart II, The JSON EcosystemPart III, JSON in the EnterpriseAppendicesCode ExamplesO’Reilly SafariHow to Contact UsAcknowledgments
I. JSON Overview and Platforms
1. JSON Overview
JSON Is a StandardA Brief SampleWhy JSON?Core JSONJSON Data TypesJSON Value TypesJSON VersionsJSON CommentsJSON File and MIME TypeJSON Style GuidelinesOur Example—MyConferenceOur Technical StackOur Architectural Style—noBackEndModel JSON Data with JSON Editor OnlineGenerate Sample JSON Data with JSON GeneratorCreate and Deploy a Stub APIWhat We Covered?What’s Next?
2. JSON in JavaScript
Node.js SetupJSON Serialization/Deserialization with JSON.stringify() and JSON.parse()The JSON Stringifier/Parser ObjectJSON Serialization with Simple JavaScript Data TypesJSON Serialization with an Object and toJSON()JSON Deserialization Using eval()JSON Deserialization with an Object and JSON.parse()JavaScript Objects and JSONNode REPLWhere to Learn More About JavaScript ObjectsUnit Testing with a Stub APIUnit Test Style—TDD and BDDJust Enough Unit Testing with Mocha and ChaiSetting Up the Unit TestUnirestTest DataSpeakers Unit TestBuilding a Small Web ApplicationYeomanIteration 1—Generate a Web Application with YeomanIteration 2—Make an HTTP Call with jQueryIteration 3—Consume Speaker Data from a Stub API and Use a TemplateHow to Go Deeper with JavaScriptWhat We CoveredWhat’s Next?
3. JSON in Ruby on Rails
Ruby on Rails SetupRuby JSON GemsJSON Serialization/Deserialization with MultiJsonThe MultiJson ObjectJSON Serialization/Deserialization with Simple Ruby Data TypesJSON Deserialization with Objects and MultiJsonA Word on Camel Casing and JSONJSON Serialization with Objects and ActiveSupportJSON Deserialization with Objects and ActiveSupportUnit Testing with a Stub APIJust Enough Unit Testing with MinitestSetting Up the Unit TestTest DataJSON and Minitest Testing with APIsSpeakers Unit TestFurther Reading on Ruby and MinitestWhat Is Missing in the Unit Tests?Build a Small Web API with Ruby on RailsChoose a JSON Serializerspeakers-api-1—Create an API with Camel-Cased JSONspeakers-api-2—Create an API that Customizes the JSON RepresentationFurther Reading on Rails and Rails-based APIsWhat We CoveredWhat’s Next?
4. JSON in Java
Java and Gradle SetupGradle OverviewJust Enough Unit Testing with JUnitJava-Based JSON LibrariesJSON Serialization/Deserialization with JacksonSerialization/Deserialization with Simple Java Data TypesSerialization/Deserialization with Java ObjectsUnit Testing with a Stub APITest DataJSON and JUnit Testing with APIsBuild a Small Web API with Spring BootCreate the ModelCreate the ControllerRegister the ApplicationWrite the Build ScriptDeploy the APITest the API with PostmanWhat We CoveredWhat’s Next?
II. The JSON Ecosystem
5. JSON Schema
JSON Schema OverviewWhat Is JSON Schema?Syntactic Versus Semantic ValidationA Simple ExampleJSON Schema on the WebWhy JSON Schema?My Journey with JSON SchemaThe Current State of the JSON Schema StandardJSON Schema and XML SchemaCore JSON Schema—Basics and ToolingJSON Schema Workflow and ToolingCore KeywordsBasic TypesNumbersArraysEnumerated ValuesObjectsPattern PropertiesRegular ExpressionsDependent PropertiesInternal ReferencesExternal ReferencesChoosing Validation RulesHow to Design and Test an API with JSON SchemaOur ScenarioModel a JSON DocumentGenerate a JSON SchemaValidate the JSON DocumentGenerate Sample DataDeploy a Stub API with json-serverFinal Thoughts on API Design and Testing with JSON SchemaValidation Using a JSON Schema LibraryWhere to Go Deeper with JSON SchemaWhat We CoveredWhat’s Next?
6. JSON Search
Why JSON Search?JSON Search Libraries and ToolsHonorable MentionWhat to Look ForTest DataSetting Up Unit TestsComparing JSON Search Libraries and ToolsJSONPathJSON PointerjqJSON Search Library and Tool Evaluations—The Bottom LineWhat We CoveredWhat’s Next?
7. JSON Transform
Types of JSON TransformationWhat to Look For in a JSON Transform LibraryTest Input DataJSON-to-HTML TransformationTarget HTML DocumentMustacheHandlebarsJSON-to-HTML Transformation Evaluations—The Bottom LineJSON-to-JSON TransformThe IssuesJSON-to-JSON Transform LibrariesHonorable MentionTarget JSON OutputJSON PatchJSON-TMustacheHandlebarsJSON-to-JSON Transformation Evaluations—The Bottom LineJSON-XML TransformationJSON-XML Transformation ConventionsThe Issues with JSON-XML Transformation ConventionsXML-JSON Transform—The Bottom LineJSON-XML Transformation Unit TestWhat We CoveredWhat’s Next?

III. JSON in the Enterprise
8. JSON and Hypermedia
Comparing Hypermedia FormatsDefining Key TermsMy Opinion on HypermediaSirenJSON-LDCollection+JSONjson:apiHALConclusions on HypermediaRecommendations for Working with HypermediaPractical Issues with HypermediaTesting with HAL in the Speakers APITest DataHAL Unit TestServer-Side HALGoing Deeper with HypermediaWhat We CoveredWhat’s Next?
9. JSON and MongoDB
What About BSON?MongoDB SetupMongoDB Server and ToolsMongoDB ServerImporting JSON into MongoDBMongoDB Command ShellBasic CRUD with mongoExporting from MongoDB to a JSON DocumentWhat About Schema?RESTful API Testing with MongoDBTest Input DataProviding a RESTful Wrapper for MongoDBWhat We CoveredWhat’s Next?
10. JSON Messaging with Kafka
Kafka Use CasesKafka Concepts and TerminologyThe Kafka Ecosystem—Related ProjectsKafka Environment SetupWhy Do I Need ZooKeeper?Kafka Command-Line Interface (CLI)How to Publish a JSON Message with the CLIStart ZooKeeperStart KafkaCreate a TopicList TopicsStart a ConsumerPublish a JSON MessageConsume a JSON MessageClean Up and Shut Down KafkaKafka LibrariesEnd-to-End Example—Speaker Proposals at MyConferenceTest DataArchitecture ComponentsSet Up the Kafka EnvironmentSet Up Fake Email Server and Client—MailCatcherSet Up Node.js Project EnvironmentSpeaker Proposal Producer (Send Speaker Proposals)Proposal Reviewer (Consumer/Producer)Speaker Notifier (Consumer)Review Notification Email Messages with MailCatcherWhat We Covered
A. Installation Guides
Install JSON Tools in the BrowserInstall JSONView in Chrome and FirefoxJSONLintJSON Editor OnlineInstall PostmanInstall Node.jsInstall Node.js on macOS and Linux with NVMInstall Node.js on WindowsUninstall Node.jsInstall YeomanInstall npm ModulesInstall Ruby on RailsInstall Rails on macOS and LinuxInstall Rails on WindowsInstall Ruby GemsInstall MongoDBInstall the Java EnvironmentInstall Java SEInstall GradleInstall jqInstall cURLInstall cURL on macOSInstall cURL on LinuxInstall cURL on WindowsInstall Apache KafkaInstall Kafka on macOSInstall Kafka on UNIXInstall Kafka on WindowsReferences
B. JSON Community
Index

Content preview from JSON at Work

Chapter 8. JSON and Hypermedia

Imagine building an application in HTML for use in a web browser. You can add forms, links, and buttons by using standard HTML, and the browser renders your new controls without requiring a new release of the browser. In the “olden days,” it didn’t work this way. If we released a new version of our server-side application with new functionality, we often had to release a new version of the client code to pair with it. Browsers changed this expectation.

We now live in a world where “rich clients” are coming back in the form of apps on people’s devices. We could just have phones access web pages, but for various reasons, people (and companies) want native apps as icons that they can touch on their devices. So how can we get rich native apps back, while still benefitting from the configurability of the browser? Hypermedia. We send not only the data, but also the actions the user can take on the data, along with a representation of how to trigger that action.

So far, the RESTful API calls and JSON responses in this book have been isolated (without reference to other calls). Each JSON response from the Speakers API has just contained data about the speaker, but without providing any information about other related resources and actions.

Hypermedia enables a REST API to guide its Consumers on the following:

Links to other related resources (e.g., other APIs). For example, a Conference API could provide links to the Reservation, Speaker, or Venue APIs ...

Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.

Read now

Unlock full access

More than 5,000 organizations count on O’Reilly

O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.

Julian F.

Head of Cybersecurity

I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.

Addison B.

Field Engineer

I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.

Amir M.

Data Platform Tech Lead

I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.

Mark W.

Embedded Software Engineer

Publisher Resources

ISBN: 9781491982389Errata Page

Cloud Computing

Data Engineering

Data Science

AI & ML

Programming Languages

Software Architecture

IT/Ops

Security

Design

Business

Soft Skills

JSON at Work

by Tom Marrs

Chapter 8. JSON and Hypermedia

Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.