Search icon CANCEL
Arrow left icon
Explore Products
Best Sellers
New Releases
Books
Videos
Audiobooks
Learning Hub
Conferences
Free Learning
Arrow right icon
Hands-On RESTful API Design Patterns and Best Practices
Hands-On RESTful API Design Patterns and Best Practices

Hands-On RESTful API Design Patterns and Best Practices: Design, develop, and deploy highly adaptable, scalable, and secure RESTful web APIs

eBook
€17.99 €26.99
Paperback
€32.99
Subscription
Free Trial
Renews at €18.99p/m

What do you get with Print?

Product feature icon Instant access to your digital eBook copy whilst your Print order is Shipped
Product feature icon Paperback book shipped to your preferred address
Product feature icon Download this book in EPUB and PDF formats
Product feature icon Access this title in our online reader with advanced features
Product feature icon DRM FREE - Read whenever, wherever and however you want
Product feature icon AI Assistant (beta) to help accelerate your learning
Table of content icon View table of contents Preview book icon Preview Book

Hands-On RESTful API Design Patterns and Best Practices

Design Strategy, Guidelines, and Best Practices

In the today's digitalized world, the challenges are about interconnecting various heterogeneous devices with abundant software services available across the internet and intranets. The application programmable interface (API) is one of the most promising software paradigms to address anything, anytime, anywhere, and any device, which is the one substantial need of the digital world at the moment. This chapter discusses how APIs and API designs help to address those challenges and bridge the gaps.

This chapter discusses a few essential API design guidelines, such as consistency, standardization, reusability, and accessibility through REST interfaces, which could equip API designers with better thought processes for their API modeling.

The following are this chapter's objectives:

  • Learning about REST API and its importance...

Technical requirements

This chapter is primarily intended to introduce readers to various RESTful design concepts involving design strategies and best practices; we expect that readers already have a basic understanding of software design concepts, client-server architecture, and basic data exchange formats, such as JSON and XML.

We assume readers have a basic understanding of web architecture, HTTP methods, headers, and related client-server concepts. However, we strongly encourage our readers to refresh their knowledge of design principles such as SOLID, OO designs, enterprise integration, SOA, and microservice architecture fundamentals.

Learning about REST API and its importance

In the first chapter, we learned about RESTful principles such as client-server, statelessness, cacheable, and layered, and we'll recognize and apply those principles to the low-level yet functional APIs in this chapter. Also, we will learn RESTful API design strategies and best practices that can help us to meet the challenge of any time, anywhere, and any device.

Let's think of an example—assume you're going to an event, where along with other activities there will be a screening of the film Solo (the latest in the Star Wars series), and you know that some of your friends joining the party aren't familiar with Star Wars and the earlier sequels. So being a tech geek, you wanted to help your friends with a simple mobile application that can send search results to your WhatsApp group as messages with details...

Goals of RESTful API design

From the API examples that we've seen so far, you might have observed that they're straightforward, unambiguous, easy to consume, well-structured, and most importantly accessible with well-known and standardized HTTP methods.

By now, we have a fair understanding of the APIs, and that they are one of the best possible solutions for resolving many digitization challenges out of the box; with our earlier examples, we also know who is consuming those APIs. Now let's ponder how we can create such usable APIs and expose them for consumption. Are there any basic and necessary principles for designing APIs that we must take into account even before we delve into API design? What should the API allow the consumers to do with it? What do the consumers want to do with it? To answer our questions, we will need to understand the following API design...

API designer roles and responsibilities

Before we discuss API design goals, principles and practices, let's touch upon the primary roles of a software architect, solution architect, software designer, or anyone who's ready to take responsibility for designing RESTful APIs.

To produce successful APIs, an API designer should have or do the following:

  • Be well-versed in REST fundamentals and API design best practices
  • Be acquainted with API design patterns to create a modern API design
  • Focus on the factors discussed in this chapter such as API design goals and best practices that can improve the application developer's experience
  • Translate the business domain into several APIs by having a clear understanding of the business vision and its functions
  • Closely work with API developers and help them with their day-to-day constraints and to deal with their existing legacy...

API design best practices

Let's think about who the consumers of any web service APIs are. Will it be another system, another software application, or an end-user? Mostly, the consumers of the APIs are another software application or another system itself. So, we can conclude that the customers of any API will be the app developers who give life to the software make it purposeful and usable by their programming codes. So the APIs are heavily dependent on the application developers or app developers.

So application developers should be the primary focus of API design, and for them to consume the APIs, there should be defined and accessible business functions. Please do remember that without any application developer or app developers ready to use the API, the API will cease to exist.

The following is a list of best practices used by API designers to produce APIs that app...

API design principles

To create flexible, scalable, and secure APIs, an API designer needs a set of guidelines. We'll discuss the following essential principles:

  • Ubiquitous web standards
  • API flexibility
  • API standardization
  • API optimization
  • API granularity
  • API sandbox or playground

By doing so, we will be able to understand how following them will help us to design high-quality RESTful APIs.

Ubiquitous web standards

As we discussed in the Goals of RESTful API design section, API designers should embrace the existing web standards and develop their API design and platforms, resulting in ubiquitous communication between the RESTful APIs and clients.

Let's ask ourselves a few questions that will help us to derive better...

RESTful API design rules

Now that we understand the roles and responsibilities of an API designer, the API design best practices, and the API design core principles, we can cover one more essential API design aspect called the rules of APIs. The best practices and design principles are guidelines that API designers try to incorporate in their API design. However, the rules of API need to be amended in the API design to make our APIs RESTful. So, this section is dedicated to RESTful API rules such as the following:

  • Use of Uniform Resource Identifiers
  • URI authority
  • Resource modelling
  • Resource archetypes
  • URI path
  • URI query
  • Metadata design rules (HTTP headers and returning error codes) and representations
  • Client concerns (versioning, security, and hypermedia processing)

We're confident that having a clear understanding of these rules will move us closer to design and begin...

Summary

As part of design strategies, we looked at what an API is and its importance for connecting devices with various other devices and technologies in the digitization era. We examined a few essential API design characteristics, such as affordance, leveraging, and maximizing existing web infrastructure, along with API design goals, such as consistency, simplification, flexible yet stable APIs, and how it is essential for an API designer to focus on the APP developers—the consumers of the APIs.

We also briefly discussed the role of an API designer and how they need to follow design principles and rules, so that they can create better RESTful APIs. We concluded this chapter by giving the necessary rules for RESTful APIs, along with some dos and don'ts.

So, we've set a strong foundation and the path for you to get your hands on API programming in our next two...

Further reading

We encourage readers to refer to https://www.packtpub.com/all for various reference materials and a vast collection of books on RESTful services and APIs.

Left arrow icon Right arrow icon
Download code icon Download Code

Key benefits

  • Understand advanced topics such as API gateways, API securities, and cloud
  • Implement patterns programmatically with easy-to-follow examples
  • Modernize legacy codebase using API connectors, layers, and microservices

Description

This book deals with the Representational State Transfer (REST) paradigm, which is an architectural style that allows networked devices to communicate with each other over the internet. With the help of this book, you’ll explore the concepts of service-oriented architecture (SOA), event-driven architecture (EDA), and resource-oriented architecture (ROA). This book covers why there is an insistence for high-quality APIs toward enterprise integration. It also covers how to optimize and explore endpoints for microservices with API gateways and touches upon integrated platforms and Hubs for RESTful APIs. You’ll also understand how application delivery and deployments can be simplified and streamlined in the REST world. The book will help you dig deeper into the distinct contributions of RESTful services for IoT analytics and applications. Besides detailing the API design and development aspects, this book will assist you in designing and developing production-ready, testable, sustainable, and enterprise-grade APIs. By the end of the book, you’ll be empowered with all that you need to create highly flexible APIs for next-generation RESTful services and applications.

Who is this book for?

This book is primarily for web, mobile, and cloud services developers, architects, and consultants who want to build well-designed APIs for creating and sustaining enterprise-class applications. You’ll also benefit from this book if you want to understand the finer details of RESTful APIs and their design techniques along with some tricks and tips.

What you will learn

  • Explore RESTful concepts, including URI, HATEOAS, and Code on Demand
  • Study core patterns like Statelessness, Pagination, and Discoverability
  • Optimize endpoints for linked microservices with API gateways
  • Delve into API authentication, authorization, and API security implementations
  • Work with Service Orchestration to craft composite and process-aware services
  • Expose RESTful protocol-based APIs for cloud computing
Estimated delivery fee Deliver to Bulgaria

Premium delivery 7 - 10 business days

€25.95
(Includes tracking information)

Product Details

Country selected
Publication date, Length, Edition, Language, ISBN-13
Publication date : Jan 31, 2019
Length: 378 pages
Edition : 1st
Language : English
ISBN-13 : 9781788992664
Languages :

What do you get with Print?

Product feature icon Instant access to your digital eBook copy whilst your Print order is Shipped
Product feature icon Paperback book shipped to your preferred address
Product feature icon Download this book in EPUB and PDF formats
Product feature icon Access this title in our online reader with advanced features
Product feature icon DRM FREE - Read whenever, wherever and however you want
Product feature icon AI Assistant (beta) to help accelerate your learning
Estimated delivery fee Deliver to Bulgaria

Premium delivery 7 - 10 business days

€25.95
(Includes tracking information)

Product Details

Publication date : Jan 31, 2019
Length: 378 pages
Edition : 1st
Language : English
ISBN-13 : 9781788992664
Languages :

Packt Subscriptions

See our plans and pricing
Modal Close icon
€18.99 billed monthly
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Simple pricing, no contract
€189.99 billed annually
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just €5 each
Feature tick icon Exclusive print discounts
€264.99 billed in 18 months
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just €5 each
Feature tick icon Exclusive print discounts

Frequently bought together


Stars icon
Total 111.97
Hands-On RESTful Python Web Services
€36.99
Enterprise API Management
€41.99
Hands-On RESTful API Design Patterns and Best Practices
€32.99
Total 111.97 Stars icon

Table of Contents

12 Chapters
Introduction to the Basics of RESTful Architecture Chevron down icon Chevron up icon
Design Strategy, Guidelines, and Best Practices Chevron down icon Chevron up icon
Essential RESTful API Patterns Chevron down icon Chevron up icon
Advanced RESTful API Patterns Chevron down icon Chevron up icon
Microservice API Gateways Chevron down icon Chevron up icon
RESTful Services API Testing and Security Chevron down icon Chevron up icon
RESTful Service Composition for Smart Applications Chevron down icon Chevron up icon
RESTful API Design Tips Chevron down icon Chevron up icon
A More In-depth View of the RESTful Services Paradigm Chevron down icon Chevron up icon
Frameworks, Standard Languages, and Toolkits Chevron down icon Chevron up icon
Legacy Modernization to Microservices-Centric Apps Chevron down icon Chevron up icon
Other Books You May Enjoy Chevron down icon Chevron up icon

Customer reviews

Top Reviews
Rating distribution
Full star icon Full star icon Empty star icon Empty star icon Empty star icon 2
(7 Ratings)
5 star 14.3%
4 star 0%
3 star 14.3%
2 star 14.3%
1 star 57.1%
Filter icon Filter
Top Reviews

Filter reviews by




Richard Chassereau Jan 06, 2020
Full star icon Full star icon Full star icon Full star icon Full star icon 5
Great information provided in this book. The table of contents makes it a little difficult to follow, but the book does offer a good deal of knowledge. This is a great for reference.
Amazon Verified review Amazon
Gustavo Caetano de Souza Feb 22, 2022
Full star icon Full star icon Full star icon Empty star icon Empty star icon 3
This is a good book until the middle, after that there are a lot of "duplicated" texts.
Amazon Verified review Amazon
Chrisian Weber Jan 08, 2020
Full star icon Full star icon Empty star icon Empty star icon Empty star icon 2
If you consider bying;Amazon offers a preview to the first pages, if you like the style and the depth in which the topics are covered, then the book is for you. If you hope that later chapters provide more details, then it is not!I returned the book, because when starting reading it i had the impression, that it lacked the depth (mostly superficial information), structure (repetitions) and quality (diagrams, writing style) to be a helpful book.
Amazon Verified review Amazon
grmrcy Jan 21, 2020
Full star icon Empty star icon Empty star icon Empty star icon Empty star icon 1
The book is repetitive, with one and the same passage reappearing many times over from chapter to chapter. Mostly talk, talk, talk. Looks like the intention was good, but the effort didn't last long enough. Does this publisher employ editors?
Amazon Verified review Amazon
Leandro Takeda Sep 26, 2019
Full star icon Empty star icon Empty star icon Empty star icon Empty star icon 1
There is a big quantity of text and no practice. There are a few codes o Java Spring but this is not the purpose of the book. A lot of theory. I understand there is a lot of effort on this book but this is maybe to who know nothing about APIs, and want some theory.
Amazon Verified review Amazon
Get free access to Packt library with over 7500+ books and video courses for 7 days!
Start Free Trial

FAQs

What is the delivery time and cost of print book? Chevron down icon Chevron up icon

Shipping Details

USA:

'

Economy: Delivery to most addresses in the US within 10-15 business days

Premium: Trackable Delivery to most addresses in the US within 3-8 business days

UK:

Economy: Delivery to most addresses in the U.K. within 7-9 business days.
Shipments are not trackable

Premium: Trackable delivery to most addresses in the U.K. within 3-4 business days!
Add one extra business day for deliveries to Northern Ireland and Scottish Highlands and islands

EU:

Premium: Trackable delivery to most EU destinations within 4-9 business days.

Australia:

Economy: Can deliver to P. O. Boxes and private residences.
Trackable service with delivery to addresses in Australia only.
Delivery time ranges from 7-9 business days for VIC and 8-10 business days for Interstate metro
Delivery time is up to 15 business days for remote areas of WA, NT & QLD.

Premium: Delivery to addresses in Australia only
Trackable delivery to most P. O. Boxes and private residences in Australia within 4-5 days based on the distance to a destination following dispatch.

India:

Premium: Delivery to most Indian addresses within 5-6 business days

Rest of the World:

Premium: Countries in the American continent: Trackable delivery to most countries within 4-7 business days

Asia:

Premium: Delivery to most Asian addresses within 5-9 business days

Disclaimer:
All orders received before 5 PM U.K time would start printing from the next business day. So the estimated delivery times start from the next day as well. Orders received after 5 PM U.K time (in our internal systems) on a business day or anytime on the weekend will begin printing the second to next business day. For example, an order placed at 11 AM today will begin printing tomorrow, whereas an order placed at 9 PM tonight will begin printing the day after tomorrow.


Unfortunately, due to several restrictions, we are unable to ship to the following countries:

  1. Afghanistan
  2. American Samoa
  3. Belarus
  4. Brunei Darussalam
  5. Central African Republic
  6. The Democratic Republic of Congo
  7. Eritrea
  8. Guinea-bissau
  9. Iran
  10. Lebanon
  11. Libiya Arab Jamahriya
  12. Somalia
  13. Sudan
  14. Russian Federation
  15. Syrian Arab Republic
  16. Ukraine
  17. Venezuela
What is custom duty/charge? Chevron down icon Chevron up icon

Customs duty are charges levied on goods when they cross international borders. It is a tax that is imposed on imported goods. These duties are charged by special authorities and bodies created by local governments and are meant to protect local industries, economies, and businesses.

Do I have to pay customs charges for the print book order? Chevron down icon Chevron up icon

The orders shipped to the countries that are listed under EU27 will not bear custom charges. They are paid by Packt as part of the order.

List of EU27 countries: www.gov.uk/eu-eea:

A custom duty or localized taxes may be applicable on the shipment and would be charged by the recipient country outside of the EU27 which should be paid by the customer and these duties are not included in the shipping charges been charged on the order.

How do I know my custom duty charges? Chevron down icon Chevron up icon

The amount of duty payable varies greatly depending on the imported goods, the country of origin and several other factors like the total invoice amount or dimensions like weight, and other such criteria applicable in your country.

For example:

  • If you live in Mexico, and the declared value of your ordered items is over $ 50, for you to receive a package, you will have to pay additional import tax of 19% which will be $ 9.50 to the courier service.
  • Whereas if you live in Turkey, and the declared value of your ordered items is over € 22, for you to receive a package, you will have to pay additional import tax of 18% which will be € 3.96 to the courier service.
How can I cancel my order? Chevron down icon Chevron up icon

Cancellation Policy for Published Printed Books:

You can cancel any order within 1 hour of placing the order. Simply contact customercare@packt.com with your order details or payment transaction id. If your order has already started the shipment process, we will do our best to stop it. However, if it is already on the way to you then when you receive it, you can contact us at customercare@packt.com using the returns and refund process.

Please understand that Packt Publishing cannot provide refunds or cancel any order except for the cases described in our Return Policy (i.e. Packt Publishing agrees to replace your printed book because it arrives damaged or material defect in book), Packt Publishing will not accept returns.

What is your returns and refunds policy? Chevron down icon Chevron up icon

Return Policy:

We want you to be happy with your purchase from Packtpub.com. We will not hassle you with returning print books to us. If the print book you receive from us is incorrect, damaged, doesn't work or is unacceptably late, please contact Customer Relations Team on customercare@packt.com with the order number and issue details as explained below:

  1. If you ordered (eBook, Video or Print Book) incorrectly or accidentally, please contact Customer Relations Team on customercare@packt.com within one hour of placing the order and we will replace/refund you the item cost.
  2. Sadly, if your eBook or Video file is faulty or a fault occurs during the eBook or Video being made available to you, i.e. during download then you should contact Customer Relations Team within 14 days of purchase on customercare@packt.com who will be able to resolve this issue for you.
  3. You will have a choice of replacement or refund of the problem items.(damaged, defective or incorrect)
  4. Once Customer Care Team confirms that you will be refunded, you should receive the refund within 10 to 12 working days.
  5. If you are only requesting a refund of one book from a multiple order, then we will refund you the appropriate single item.
  6. Where the items were shipped under a free shipping offer, there will be no shipping costs to refund.

On the off chance your printed book arrives damaged, with book material defect, contact our Customer Relation Team on customercare@packt.com within 14 days of receipt of the book with appropriate evidence of damage and we will work with you to secure a replacement copy, if necessary. Please note that each printed book you order from us is individually made by Packt's professional book-printing partner which is on a print-on-demand basis.

What tax is charged? Chevron down icon Chevron up icon

Currently, no tax is charged on the purchase of any print book (subject to change based on the laws and regulations). A localized VAT fee is charged only to our European and UK customers on eBooks, Video and subscriptions that they buy. GST is charged to Indian customers for eBooks and video purchases.

What payment methods can I use? Chevron down icon Chevron up icon

You can pay with the following card types:

  1. Visa Debit
  2. Visa Credit
  3. MasterCard
  4. PayPal
What is the delivery time and cost of print books? Chevron down icon Chevron up icon

Shipping Details

USA:

'

Economy: Delivery to most addresses in the US within 10-15 business days

Premium: Trackable Delivery to most addresses in the US within 3-8 business days

UK:

Economy: Delivery to most addresses in the U.K. within 7-9 business days.
Shipments are not trackable

Premium: Trackable delivery to most addresses in the U.K. within 3-4 business days!
Add one extra business day for deliveries to Northern Ireland and Scottish Highlands and islands

EU:

Premium: Trackable delivery to most EU destinations within 4-9 business days.

Australia:

Economy: Can deliver to P. O. Boxes and private residences.
Trackable service with delivery to addresses in Australia only.
Delivery time ranges from 7-9 business days for VIC and 8-10 business days for Interstate metro
Delivery time is up to 15 business days for remote areas of WA, NT & QLD.

Premium: Delivery to addresses in Australia only
Trackable delivery to most P. O. Boxes and private residences in Australia within 4-5 days based on the distance to a destination following dispatch.

India:

Premium: Delivery to most Indian addresses within 5-6 business days

Rest of the World:

Premium: Countries in the American continent: Trackable delivery to most countries within 4-7 business days

Asia:

Premium: Delivery to most Asian addresses within 5-9 business days

Disclaimer:
All orders received before 5 PM U.K time would start printing from the next business day. So the estimated delivery times start from the next day as well. Orders received after 5 PM U.K time (in our internal systems) on a business day or anytime on the weekend will begin printing the second to next business day. For example, an order placed at 11 AM today will begin printing tomorrow, whereas an order placed at 9 PM tonight will begin printing the day after tomorrow.


Unfortunately, due to several restrictions, we are unable to ship to the following countries:

  1. Afghanistan
  2. American Samoa
  3. Belarus
  4. Brunei Darussalam
  5. Central African Republic
  6. The Democratic Republic of Congo
  7. Eritrea
  8. Guinea-bissau
  9. Iran
  10. Lebanon
  11. Libiya Arab Jamahriya
  12. Somalia
  13. Sudan
  14. Russian Federation
  15. Syrian Arab Republic
  16. Ukraine
  17. Venezuela