research-article

On using JSON-LD to create evolvable RESTful services

Authors:

Markus Lanthaler,

Christian GütlAuthors Info & Claims

WS-REST '12: Proceedings of the Third International Workshop on RESTful Design

Pages 25 - 32

https://doi.org/10.1145/2307819.2307827

Published: 17 April 2012 Publication History

Abstract

As the amount of data and devices on the Web experiences exponential growth issues on how to integrate such hugely heterogeneous components into a scalable system become increasingly important. REST has proven to be a viable solution for such large-scale information systems. It provides a set of architectural constraints that, when applied as a whole, result in benefits in terms of loose coupling, maintainability, evolvability, and scalability. Unfortunately, some of REST's constraints such as the ones that demand self-descriptive messages or require the use of hypermedia as the engine of application state are rarely implemented correctly. This results in tightly coupled and thus brittle systems. To solve these and other issues, we present JSON-LD, a community effort to standardize a media type targeted to machine-to-machine communication with inherent hypermedia support and rich semantics. Since JSON-LD is 100% compatible with traditional JSON, developers can continue to use their existing tools and libraries. As we show in the paper, JSON-LD can be used to build truly RESTful services that, at the same time, integrate the exposed data into the Semantic Web. The required additional design costs are significantly outweighed by the achievable benefits in terms of loose coupling, evolvability, scalability, self-descriptiveness, and maintainability.

References

[1]

R. T. Fielding, "Architectural styles and the design of network-based software architectures," PhD dissertation, Department of Information and Computer Science, University of California, Irvine, 2000.

Digital Library

[2]

C. Pautasso and E. Wilde, "Why is the Web Loosely Coupled? A Multi-Faceted Metric for Service Design," in Proceedings of the 18^th International Conference on World Wide Web (WWW), 2009, pp. 911--920.

Digital Library

[3]

The Atom Syndication Format. {Online}. Available: http://tools.ietf.org/html/rfc4287.

[4]

The Atom Publishing Protocol. {Online}. Available: http://tools.ietf.org/html/rfc5023.

[5]

Open Data Protocol. {Online}. Available: http://www.odata.org/.

[6]

Google Data Protocol. {Online}. Available: http://code.google.com/apis/gdata/.

[7]

M. Lanthaler and C. Gütl, "SAPS: Semantic AtomPub-based Services," in Proceedings of the 11^th IEEE/IPSJ International Symposium on Applications and the Internet (SAINT), 2011, pp. 382--387.

Digital Library

[8]

T. Vitvar and J. Musser, "ProgrammableWeb.com: Statistics, trends, and best practices," Keynote of the Web APIs and Service Mashups Workshop at the European Conference on Web Services, 2010.

[9]

RDF/JSON, Talis Systems Ltd., 2011. {Online}. Available: http://docs.api.talis.com/platform-api/output-types/rdf-json. {Accessed: 15-Jan-2012}.

[10]

K. Zyp and G. Court, "JSON Schema", 2010. {Online}. Available: http://tools.ietf.org/html/draft-zyp-json-schema-03. {Accessed: 18-Jan-2011}.

[11]

P. Bryan and K. Zyp, "JSON Reference", 2011. {Online}. Available: http://tools.ietf.org/html/draft-pbryan-zyp-json-ref-01. {Accessed: 20-Dec-2011}.

[12]

M. Kelly, "HAL - Hypertext Application Language", 2011. {Online}. Available: http://stateless.co/hal_specification.html. {Accessed: 20-Dec-2011}.

[13]

M. Amundsen, "Collection+JSON - Document Format", 2011. {Online}. Available: http://amundsen.com/media-types/collection/format/. {Accessed: 24-Oct-2011}.

[14]

Y. Goland, "Adding Namespaces to JSON", 2006. {Online}. Available: http://www.goland.org/jsonnamespace/. {Accessed: 05-Jan-2012}.

[15]

T. Berners-Lee, "Linked Data," Design Issues for the World Wide Web, 2006. {Online}. Available: http://www.w3.org/DesignIssues/LinkedData.html. {Accessed: 06-Jun-2010}.

[16]

RDF Working Group, "JSON Serializations by Example", 2011. {Online}. Available: http://www.w3.org/2011/rdf-wg/wiki/JSON-Serialization-Examples. {Accessed: 28-Jul-2011}.

[17]

K. R. Page, D. C. De Roure, and K. Martinez, "REST and Linked Data: a match made for domain driven development?" in Proceedings of the 2^nd International Workshop on RESTful Design (WS-REST), 2011, pp. 22--25.

Digital Library

[18]

M. Lanthaler and C. Gütl, "A Semantic Description Language for RESTful Data Services to Combat Semaphobia," in Proceedings of the 2011 5^th IEEE International Conference on Digital Ecosystems and Technologies (DEST), 2011, pp. 47--53.

[19]

RDF/XML Syntax Specification (Revised). {Online}. Available: http://www.w3.org/TR/2004/REC-rdf-syntax-grammar-20040210/.

[20]

RDFa in XHTML: Syntax and Processing. {Online}. Available: http://www.w3.org/TR/2008/REC-rdfa-syntax-20081014.

[21]

M. Sporny, "Linked JSON: RDF for the Masses," The Beautiful, Tormented Machine, 2011. {Online}. Available: http://manu.sporny.org/2011/linked-json/. {Accessed: 28-Apr-2011}.

[22]

I. Herman, "W3C Workshop --- RDF Next Steps Workshop Report," 2010. {Online}. Available: http://www.w3.org/2009/12/rdf-ws/Report.html. {Accessed: 05-Aug-2010}.

[23]

T. Steiner, "JSON Emergency Brake," RDF Working Group mailing list, 2011. {Online}. Available: http://lists.w3.org/Archives/Public/public-rdf-wg/2011Aug/0131.html. {Accessed: 23-Aug-2011}.

[24]

JSON for Linking Data Community Group, W3C Community and Business Groups. {Online}. Available: http://www.w3.org/community/json-ld/.

[25]

JSON-LD - Linked Data Expression in JSON, Unofficial Draft 30 May 2010. {Online}. Available: http://json-ld.org/spec/ED/json-ld-syntax/20100529/.

[26]

JSON-LD Syntax 1.0, Unofficial Draft 26 April 2012. {Online}. Available: http://json-ld.org/spec/ED/json-ld-syntax/20120426/.

[27]

D. Brickley and L. Miller, FOAF Vocabulary Specification 0.98. 2010. {Online}. Available: http://xmlns.com/foaf/spec/. {Accessed: 17-Jan-2011}.

[28]

L. Dodds and I. Davis, Linked Data Patterns - A pattern catalogue for modelling, publishing, and consuming Linked Data, 2011, pp. 44--55. {Online}. Available: http://patterns.dataincubator.org/book/linked-data-patterns.pdf. {Accessed: 07-Oct-2011}.

[29]

The JSON-LD API 1.0, Unofficial Draft 26 April 2012. {Online}. Available: http://json-ld.org/spec/ED/json-ld-api/20120426/.

[30]

R. T. Fielding, "REST APIs must be hypertext-driven," Untangled musings of Roy T. Fielding, 2008. {Online}. Available: http://roy.gbiv.com/untangled/2008/rest-apis-must-be-hypertext-driven. {Accessed: 02-Jun-2010}.

[31]

S. Parastatidis, J. Webber, G. Silveira, and I. S. Robinson, "The Role of Hypermedia in Distributed System Development," in Proceedings of the 1^st International Workshop on RESTful Design (WS-REST), 2010, pp. 16--22.

Digital Library

[32]

Link Relations, IANA. {Online}. Available: http://www.iana.org/assignments/link-relations/link-relations.xml.

[33]

OWL 2 Web Ontology Language. {Online}. Available: http://www.w3.org/TR/2009/REC-owl2-primer-20091027/.

Cited By

Shatnawi HSaquer JLo DGamess E(2024)Encoding Feature Models in Neo4j Graph DatabaseProceedings of the 2024 ACM Southeast Conference10.1145/3603287.3651199(157-166)Online publication date: 18-Apr-2024
https://dl.acm.org/doi/10.1145/3603287.3651199
Coolidge WSørensen SKjærgaard M(2024)On the Design of Adaptive Robotic Systems Using Room Sensors, Anchoring, Semantic, and Low-Code Technologies2024 IEEE 21st International Conference on Software Architecture Companion (ICSA-C)10.1109/ICSA-C63560.2024.00060(319-325)Online publication date: 4-Jun-2024
https://doi.org/10.1109/ICSA-C63560.2024.00060
Lu YZhang JQi YQi SLi YSong HLiu Y(2023)Safety Warning! Decentralised and Automated Incentives for Disqualified Drivers Auditing in Ride-Hailing ServicesIEEE Transactions on Mobile Computing10.1109/TMC.2021.310801222:3(1748-1762)Online publication date: 1-Mar-2023
https://doi.org/10.1109/TMC.2021.3108012
Show More Cited By

Index Terms

On using JSON-LD to create evolvable RESTful services
1. Information systems
2. Software and its engineering
  1. Software organization and properties
    1. Software system structures
      1. Software architectures

Recommendations

Providing Research Graph Data in JSON-LD Using Schema.org
WWW '17 Companion: Proceedings of the 26th International Conference on World Wide Web Companion

In this position paper, we describe a pilot project that provides Research Graph records to external web services using JSON-LD. The Research Graph database contains a large-scale graph that links research datasets (i.e., data used to support research) ...
A Maturity Model for Semantic RESTful Web APIs
ICWS '15: Proceedings of the 2015 IEEE International Conference on Web Services

Web APIs provide interfaces for interaction among systems based on the existing infrastructure for hosting Web sites and applications. The REST architectural style is the most employed approach for building Web APIs. However, the flexibility provided by ...
Hypercat JSON-LD: A Semantically Enriched Catalogue Format for IoT
WIMS2019: Proceedings of the 9th International Conference on Web Intelligence, Mining and Semantics

The rapidly increasing number of sensor networks and smart devices contributed to the generation of a huge amount of information. Information that is generated by various sources and is published in different formats high-lights interoperability as one ...

Comments

Please enable JavaScript to view thecomments powered by Disqus.

Information & Contributors

Information

Published In

cover image ACM Other conferences

WS-REST '12: Proceedings of the Third International Workshop on RESTful Design

April 2012

64 pages

ISBN:9781450311908

DOI:10.1145/2307819

Copyright © 2012 ACM.

Permission to make digital or hard copies of all or part of this work for personal or classroom use is granted without fee provided that copies are not made or distributed for profit or commercial advantage and that copies bear this notice and the full citation on the first page. Copyrights for components of this work owned by others than ACM must be honored. Abstracting with credit is permitted. To copy otherwise, or republish, to post on servers or to redistribute to lists, requires prior specific permission and/or a fee. Request permissions from [email protected]

Publisher

Association for Computing Machinery

New York, NY, United States

Publication History

Published: 17 April 2012

Permissions

Request permissions for this article.

Request Permissions

Check for updates

Author Tags

Qualifiers

Research-article

Conference

WS-REST '12

WS-REST '12: Third International Workshop on RESTful Design

April 17, 2012

Lyon, France

Acceptance Rates

WS-REST '12 Paper Acceptance Rate 8 of 20 submissions, 40%;

Overall Acceptance Rate 8 of 20 submissions, 40%

Contributors

Other Metrics

View Article Metrics

Bibliometrics & Citations

Bibliometrics

Article Metrics

83
Total Citations
View Citations
954
Total Downloads

Downloads (Last 12 months)29
Downloads (Last 6 weeks)0

Reflects downloads up to 26 Sep 2024

Other Metrics

View Author Metrics

Citations

Cited By

Shatnawi HSaquer JLo DGamess E(2024)Encoding Feature Models in Neo4j Graph DatabaseProceedings of the 2024 ACM Southeast Conference10.1145/3603287.3651199(157-166)Online publication date: 18-Apr-2024
https://dl.acm.org/doi/10.1145/3603287.3651199
Coolidge WSørensen SKjærgaard M(2024)On the Design of Adaptive Robotic Systems Using Room Sensors, Anchoring, Semantic, and Low-Code Technologies2024 IEEE 21st International Conference on Software Architecture Companion (ICSA-C)10.1109/ICSA-C63560.2024.00060(319-325)Online publication date: 4-Jun-2024
https://doi.org/10.1109/ICSA-C63560.2024.00060
Lu YZhang JQi YQi SLi YSong HLiu Y(2023)Safety Warning! Decentralised and Automated Incentives for Disqualified Drivers Auditing in Ride-Hailing ServicesIEEE Transactions on Mobile Computing10.1109/TMC.2021.310801222:3(1748-1762)Online publication date: 1-Mar-2023
https://doi.org/10.1109/TMC.2021.3108012
Andročec DTomašić M(2023)Using GPT-3 to Automatically Create RESTful Service Descriptions2023 4th International Conference on Communications, Information, Electronic and Energy Systems (CIEES)10.1109/CIEES58940.2023.10378839(1-4)Online publication date: 23-Nov-2023
https://doi.org/10.1109/CIEES58940.2023.10378839
Bowden DGrimes D(2023)Intelligent Image Compression Using Traffic Scene AnalysisArtificial Intelligence and Cognitive Science10.1007/978-3-031-26438-2_26(332-343)Online publication date: 23-Feb-2023
https://doi.org/10.1007/978-3-031-26438-2_26
Zhang LPang KXu JNiu B(2022)JSON-based control model for SQL and NoSQL data conversion in hybrid cloud databaseJournal of Cloud Computing10.1186/s13677-022-00302-911:1Online publication date: 3-Aug-2022
https://doi.org/10.1186/s13677-022-00302-9
Amith MCui LZhi DRoberts KJiang XLi FYu ETao C(2022)Toward a standard formal semantic representation of the model card reportBMC Bioinformatics10.1186/s12859-022-04797-623:S6Online publication date: 14-Jul-2022
https://doi.org/10.1186/s12859-022-04797-6
Fernandez-Iglesias MAnido-Rifon LValladares-Rodriguez SPacheco-Lorenzo M(2022)Integration of Diagnosis Application Data using FHIRProceedings of the 2022 International Conference on Intelligent Medicine and Health10.1145/3560071.3560088(64-69)Online publication date: 19-Aug-2022
https://dl.acm.org/doi/10.1145/3560071.3560088
Parra-Royon MAtemezing GBenitez J(2022)Semantics of Data Mining Services in Cloud ComputingIEEE Transactions on Services Computing10.1109/TSC.2020.296660715:2(945-955)Online publication date: 1-Mar-2022
https://doi.org/10.1109/TSC.2020.2966607
Haibi AOufaska KBouya MEl Yassini KBoulmalf M(2022)Research gaps and trends in Radio Frequency Identification: Scoping review2022 Microwave Mediterranean Symposium (MMS)10.1109/MMS55062.2022.9825532(1-6)Online publication date: 9-May-2022
https://doi.org/10.1109/MMS55062.2022.9825532
Show More Cited By

View Options

Get Access

Login options

Check if you have access through your login credentials or your institution to get full access on this article.

Full Access

Get this Publication

View options

PDF

View or Download as a PDF file.

eReader

View online with eReader.

Media

Figures

Other

Tables

View Table of Contents