Skip to main content

Defining Design Patterns for IoT APIs

  • Conference paper
  • First Online:
Software Architecture (ECSA 2020)

Part of the book series: Communications in Computer and Information Science ((CCIS,volume 1269))

Included in the following conference series:

Abstract

Smart devices (or things) in the realm of IoT (Internet of Things) talk to each other and transfer data over the Internet. IoT vendors provide APIs for their clients to send data to the gateways and application servers. However, there is a lack of guidelines on how a vendor would design its API and resource URIs (Uniform Resource Identifiers). A generic design solution – design patterns – would make the API design and development easier for the vendors. Design patterns are reusable solutions to recurring problems and provide improved reusability and understandability. Currently, there are no design patterns for IoT APIs that IoT vendors can use. In this paper, we analyzed more than 1,300 URIs from 13 IoT APIs including IBM Watson and Microsoft Azure, and proposed eight novel design patterns for IoT APIs. We analyzed two datasets: (1) analysis set with 70% of all our URIs to define design patterns for IoT APIs and (2) validation set with the remaining 30% of the URIs to verify the prevalence of defined design patterns. We found that design patterns are prevalent in the IoT domain.

This is a preview of subscription content, log in via an institution to check access.

Access this chapter

Chapter
USD 29.95
Price excludes VAT (USA)
  • Available as PDF
  • Read on any device
  • Instant download
  • Own it forever
eBook
USD 84.99
Price excludes VAT (USA)
  • Available as EPUB and PDF
  • Read on any device
  • Instant download
  • Own it forever
Softcover Book
USD 109.99
Price excludes VAT (USA)
  • Compact, lightweight edition
  • Dispatched in 3 to 5 business days
  • Free shipping worldwide - see info

Tax calculation will be finalised at checkout

Purchases are for personal use only

Institutional subscriptions

Notes

  1. 1.

    http://aceproject.org/main/english/es/esd01.htm.

References

  1. Abbas, S., Ojo, A.: Applying design patterns in URI strategies-naming in linked geospatial data infrastructure. In: 2014 47th Hawaii International Conference on System Sciences, pp. 2094–2103. IEEE (2014)

    Google Scholar 

  2. Fielding, R.T., Taylor, R.N.: Architectural Styles and the Design of Network-based Software Architectures, vol. 7. University of California, Irvine (2000)

    Google Scholar 

  3. Gamma, E.: Design Patterns: Elements of Reusable Object-Oriented Software. Pearson Education India (1995)

    Google Scholar 

  4. Grønbæk, I.: Architecture for the Internet of Things (IoT): API and interconnect. In: 2008 Second International Conference on Sensor Technologies and Applications (Sensorcomm 2008), pp. 802–807. IEEE (2008)

    Google Scholar 

  5. Network Working Group: Uniform Resource Identifier (URI): Generic Syntax (2005). https://tools.ietf.org/html/rfc3986

  6. Li, L., Chou, W., Zhou, W., Luo, M.: Design patterns and extensibility of rest API for networking applications. IEEE Trans. Netw. Serv. Manag. 13(1), 154–167 (2016)

    Article  Google Scholar 

  7. Masse, M.: REST API Design Rulebook: Designing Consistent RESTful Web Service Interfaces. O’Reilly Media Inc., Newton (2011)

    Google Scholar 

  8. McEwen, A., Cassimally, H.: Designing the Internet of Things. Wiley, Hoboken (2013)

    Google Scholar 

  9. Richardson, L., Amundsen, M.: RESTful Web APIs. O’Reilly (2013). https://books.google.se/books?id=ppEVtAEACAAJ

  10. Subramanian, H., Raj, P.: Hands-on RESTful Web API Design Patterns and Best Practices: Design, Develop, and Deploy Highly Adaptable, Scalable, and Secure RESTful Web APIs. Packt Publishing (2019)

    Google Scholar 

  11. Tracz, W.: Where does reuse start? ACM SIGSOFT Softw. Eng. Notes 15(2), 42–46 (1990)

    Article  Google Scholar 

  12. Wilkinson, M.D., Vandervalk, B., McCarthy, L.: The semantic automated discovery and integration (SADI) web service design-pattern, API and reference implementation. J. Biomed. Semant. 2(1), 8 (2011)

    Article  Google Scholar 

  13. Zhou, W., Li, L., Luo, M., Chou, W.: REST API design patterns for SDN northbound API. In: 2014 28th International Conference on Advanced Information Networking and Applications Workshops, pp. 358–365. IEEE (2014)

    Google Scholar 

Download references

Acknowledgment

We would like to thank The Knowledge Foundation that partially supported this research through two projects with ref no. 20150088 and 20170176, respectively. This study is conducted with support from Linnaeus University Centre for Data Intensive Sciences and Applications (DISA).

Author information

Authors and Affiliations

Authors

Corresponding author

Correspondence to Francis Palma .

Editor information

Editors and Affiliations

Rights and permissions

Reprints and permissions

Copyright information

© 2020 Springer Nature Switzerland AG

About this paper

Check for updates. Verify currency and authenticity via CrossMark

Cite this paper

Svensson, R., Tatrous, A., Palma, F. (2020). Defining Design Patterns for IoT APIs. In: Muccini, H., et al. Software Architecture. ECSA 2020. Communications in Computer and Information Science, vol 1269. Springer, Cham. https://doi.org/10.1007/978-3-030-59155-7_32

Download citation

  • DOI: https://doi.org/10.1007/978-3-030-59155-7_32

  • Published:

  • Publisher Name: Springer, Cham

  • Print ISBN: 978-3-030-59154-0

  • Online ISBN: 978-3-030-59155-7

  • eBook Packages: Computer ScienceComputer Science (R0)

Publish with us

Policies and ethics