Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.
API Design Tour:DellRound Rock, Texas, USABrian Mulloy              Apigee@landlessness            @apigee
groups.google.com/group/api-craft
youtube.com/apigee
slideshare.net/apigee
@Dell@sbelekar       @ravichittur   @ctboyland@apigee@landlessness
What does your company do?
Why do you have an API? How did it get started?
Who are your target developers? Internal?Partners? Open?
How is your API used?
What is your API design philosophy?
Which aspects of the API design have generatedthe most discussion internally and externally?
How do you approach URI design?URI Examples/content/customize/v2/{app_root}/{file}.(xml|json)/support/assetinfo/v2/summary...
How do you handle multiple formats? What is yourdefault?/support/assetinfo/v2/summary.xml/support/assetinfo/v2/summary.jso...
How do you handle pagination?Limit & Offsethttps://sandbox.api.dell.com/support/assetinfo/v2/summary.xml?svctags=2sqs3bs&l...
How do you handle metadata in your responses?
How do you handle counting?
How do you approach HTTP Verbs?
Which convention do you use for responseattribute names?
How do you handle errors?HTTP Status Codes200 301 302 400 500Typical Error Response Template<Code>eAPI-40420</Code><Messag...
How do you handle versions?/support/assetinfo/v2/header.{xml/json}
How do you handle backwards compatibility,deprecation and obsolescence?
How do you handle search?
What design flourishes are you proud of?
What changes have you made to your designbecause it was confusing for developers?
What are your top level sub domain names foryour API and your developer portal?http://api.dell.com/http://developer.dell.c...
How do you handle authentication andauthorization?
How do you handle SDKs and code libraries?
How have performance considerations impactedyour API design?
What challenges can API Teams anticipate as theyimplement their API initiatives?
What is on your API roadmap?
What else should we know about your API?
Questions from audience?
THANK YOUSubscribe to API webcasts at:youtube.com/apigee
THANK YOUQuestions and ideas to:groups.google.com/group/api-craft
THANK YOUContact me at:@landlessnessbrian@apigee.com@apigee
Upcoming SlideShare
Loading in …5
×

API Design Tour: Dell

4,246 views

Published on

Published in: Technology

API Design Tour: Dell

  1. 1. API Design Tour:DellRound Rock, Texas, USABrian Mulloy Apigee@landlessness @apigee
  2. 2. groups.google.com/group/api-craft
  3. 3. youtube.com/apigee
  4. 4. slideshare.net/apigee
  5. 5. @Dell@sbelekar @ravichittur @ctboyland@apigee@landlessness
  6. 6. What does your company do?
  7. 7. Why do you have an API? How did it get started?
  8. 8. Who are your target developers? Internal?Partners? Open?
  9. 9. How is your API used?
  10. 10. What is your API design philosophy?
  11. 11. Which aspects of the API design have generatedthe most discussion internally and externally?
  12. 12. How do you approach URI design?URI Examples/content/customize/v2/{app_root}/{file}.(xml|json)/support/assetinfo/v2/summary.xml?svctags=2sqs3bsResponse<?xml version="1.0" encoding="utf-8"?><GetAssetSummaryResponse xmlns=http://tempuri.org/><GetAssetSummaryResult xmlns:a="http://schemas.datacontract.org/2004/07/Dell.AWR.Domain.Asset"xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:Faults/> <a:Response xmlns:b="http://schemas.datacontract.org/2004/07/Dell.AWR.Domain.Asset.Mobile"> <b:DellAsset> <b:AssetParts> <b:AssetPart> <b:PartDescription>Processor,T9550,2.66,6MB,Core Penryn,35W,E0</b:PartDescription> <b:PartDescriptionRefined>Processor, T9550, 2.66, 6MB, Core Penryn, 35W, E0</b:PartDescriptionRefined> <b:PartNumber>H185K</b:PartNumber> <b:Quantity>1</b:Quantity>
  13. 13. How do you handle multiple formats? What is yourdefault?/support/assetinfo/v2/summary.xml/support/assetinfo/v2/summary.json XML is the default.
  14. 14. How do you handle pagination?Limit & Offsethttps://sandbox.api.dell.com/support/assetinfo/v2/summary.xml?svctags=2sqs3bs&limit=20&offset=1
  15. 15. How do you handle metadata in your responses?
  16. 16. How do you handle counting?
  17. 17. How do you approach HTTP Verbs?
  18. 18. Which convention do you use for responseattribute names?
  19. 19. How do you handle errors?HTTP Status Codes200 301 302 400 500Typical Error Response Template<Code>eAPI-40420</Code><Message>Resource Not Found</Message><Reason>Failed to find the resource: ${Config File Name} for API:${APIName}</Reason><Source>Gateway</Source>
  20. 20. How do you handle versions?/support/assetinfo/v2/header.{xml/json}
  21. 21. How do you handle backwards compatibility,deprecation and obsolescence?
  22. 22. How do you handle search?
  23. 23. What design flourishes are you proud of?
  24. 24. What changes have you made to your designbecause it was confusing for developers?
  25. 25. What are your top level sub domain names foryour API and your developer portal?http://api.dell.com/http://developer.dell.com/ Currently API & developer portal are internal only.
  26. 26. How do you handle authentication andauthorization?
  27. 27. How do you handle SDKs and code libraries?
  28. 28. How have performance considerations impactedyour API design?
  29. 29. What challenges can API Teams anticipate as theyimplement their API initiatives?
  30. 30. What is on your API roadmap?
  31. 31. What else should we know about your API?
  32. 32. Questions from audience?
  33. 33. THANK YOUSubscribe to API webcasts at:youtube.com/apigee
  34. 34. THANK YOUQuestions and ideas to:groups.google.com/group/api-craft
  35. 35. THANK YOUContact me at:@landlessnessbrian@apigee.com@apigee

×