InfoQ Homepage Presentations Designing Pragmatic RESTful APIs
Designing Pragmatic RESTful APIs
Summary
Anupama Natarajan presents key principles to consider when designing RESTful APIs based on her experience designing them for real-world applications.
Bio
Anupama Natarajan has 15 years of commercial experience in designing and developing enterprise applications, data warehouse and business intelligence solutions. She has ability to communicate and simplify architectural solutions to various audiences of IT and businesses. She’s passionate about designing modern API-centric solutions using multiple technology stacks.
About the conference
The API Days NZ Conference is organised by HYPR and Deloitte for the benefit of the API community. This includes anyone who is interested in improving the way New Zealand organisations share digital resources with customers using APIs. API Days is all about collaboration and sharing stories.
Community comments
Worth watching.
by Andrea Mussap,
Re: Worth watching.
by Roxana Bacila,
Re: Worth watching.
by Anupama Natarajan,
Worth watching.
by rishiraj shukla,
Re: Worth watching.
by Anupama Natarajan,
Re: Worth watching.
by Charles Okwuagwu,
Good one
by Mohideen Minhaj,
Worth watching.
by Andrea Mussap,
Your message is awaiting moderation. Thank you for participating in the discussion.
I love the analogies people use to explain what APIs are, and I really liked the one Anupama presented here.
From this talk I'd highlight two points:
- How to explain what APIs are: "you know about APIs, but how do you explain to your business' users what APIs are?".
- Documenting APIs: There's no doubt that documentation is important to help your customer to use your API, but it should be used as a support. If the customer has to go through pages and pages to understand your API, you already lost them.
* There's a typo on the name of the speaker, I had a problem to find here on Twitter because of this. From 'Naturajan' to 'Natarajan'
Re: Worth watching.
by Roxana Bacila,
Your message is awaiting moderation. Thank you for participating in the discussion.
Hi Andrea,
Thank you for drawing our attention to the error with the speaker name. This is now corrected. We apologize for any inconvenience this might have caused you.
Best,
Roxana Bacila
Community Manager
InfoQ Enterprise Software Development Community
InfoQ.com | InfoQ China | InfoQ Japan | InfoQ Brazil | InfoQ France | QCon
Worth watching.
by rishiraj shukla,
Your message is awaiting moderation. Thank you for participating in the discussion.
Hi Anupama Natarajan,
I am watching your presentation ,really it is very good and inspirational and motivational.API design and how to make a API is more wonderful.
Thanks to you.
Regards,
Rishiraj
Re: Worth watching.
by Anupama Natarajan,
Your message is awaiting moderation. Thank you for participating in the discussion.
Thanks Andrea and also pointing out the typo.
Anu
Re: Worth watching.
by Anupama Natarajan,
Your message is awaiting moderation. Thank you for participating in the discussion.
Thanks Rishiraj
Anu
Good one
by Mohideen Minhaj,
Your message is awaiting moderation. Thank you for participating in the discussion.
Thanks Anupama. wonderful presentation. Good Insight to API design.
Best Regards
Re: Worth watching.
by Charles Okwuagwu,
Your message is awaiting moderation. Thank you for participating in the discussion.
Hi Anupama Natarajan,
This is very good and concise information. Two questions please:
1) What do you change (relax / add) when the API in question is an internal facing API?
2) I've been looking for good guidance on implementing Paging, sorting and specifying the fields to return for an API.
Please can you point to any frameworks / material you have used to achieve this.
I'm developing mainly on the Microsoft's .NET Stack, sadly there is nothing out of the box that gives us prescriptive guidance on proper API design with all the items you mentioned.
If frameworks could bake-in a lot of the "best practices" you mentioned here, it would raise the bar on API quality in general.
Regards.
Charles