Skip to main content

API Design Best Practices

  • Chapter
  • First Online:
REST API Development with Node.js
  • 3712 Accesses

Abstract

The practice of API design is a tricky one. Even when there are so many options out there—tools to use, standards to apply, styles to follow—there is one basic question that needs to be answered and needs to be clear in the developer’s mind before any kind design and development can begin…

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 54.99
Price excludes VAT (USA)
  • Available as EPUB and PDF
  • Read on any device
  • Instant download
  • Own it forever
Softcover Book
USD 69.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.

    See http://www.w3.org/Protocols/rfc2616/rfc2616.html .

  2. 2.

    XML is not strictly a Data Transfer Format, but it’s being used as one.

  3. 3.

    Source: http://www.slideshare.net/3scale/apis-for-biz-dev-20-which-business-model-15473323 .

  4. 4.

    Source: http://www.slideshare.net/3scale/apis-for-biz-dev-20-which-business-model-15473323 , April 2010.

  5. 5.

    Source: http://www.slideshare.net/3scale/apis-for-biz-dev-20-which-business-model-15473323 , October 2009.

  6. 6.

    Source: http://www.slideshare.net/3scale/apis-for-biz-dev-20-which-business-model-15473323 , May 2011.

  7. 7.

    See https://help.ubuntu.com/community/CommonQuestions#Ubuntu_Releases_and_Version_Numbers .

  8. 8.

    See http://www.chromium.org/developers/version-numbers .

  9. 9.

    See semver.org.

  10. 10.

    See https://developers.facebook.com/docs/graph-api/using-graph-api/v2.1 .

  11. 11.

    See https://github.com/4chan/4chan-API .

  12. 12.

    See https://developers.facebook.com (see the bottom of the page for the list of SDKs).

  13. 13.

    See https://developers.google.com/maps/ .

  14. 14.

    See https://dev.twitter.com/overview/api/twitter-libraries .

  15. 15.

    See https://github.com/aws .

  16. 16.

    See https://www.ietf.org/rfc/rfc2617.txt .

  17. 17.

    See http://oauth.net/core/1.0a/ .

Author information

Authors and Affiliations

Authors

Rights and permissions

Reprints and permissions

Copyright information

© 2018 Fernando Doglio

About this chapter

Check for updates. Verify currency and authenticity via CrossMark

Cite this chapter

Doglio, F. (2018). API Design Best Practices. In: REST API Development with Node.js . Apress, Berkeley, CA. https://doi.org/10.1007/978-1-4842-3715-1_2

Download citation

Publish with us

Policies and ethics