云计算api理论方法

APIDesign3rdEditionKevinSwiber@kevinswiberApigee@apigeeBrianMulloy@landlessness

/group/api-craft/apigee/apigee@landlessness@kevinswiber“Therealissueisaboutdesign:designingthingsthathavethepowerrequiredforthejobwhilemaintainingunderstandability,thefeelingofcontrol,andthepleasureofaccomplishment.-DonaldNorman/photos/mattharvey1/5712604622/AgendaRecapPreviousEditionAPIModelingSecurityMessageDesignHypermediaTransactions/web-api-design-ebook/URLDesignPluralnounsforcollections/dogsIDforentity/dogs/1234Associations/owners/5678/dogs4HTTPMethodsPOST

GETPUTDELETEBiastowardconcretenames/dogs(notanimals)MultipleformatsinURL/dogs.json/dogs.xmlPaginatewithlimitandoffset?limit=10&offset=0Queryparams?color=red&state=runningPartialselection?fields=name,stateUsemedialcapitalization

"createdAt":1320296464myObject.createdAt;Useverbsfornon-resourcerequests/convert?from=EUR&to=CNY&amount=100Search/search?q=happy%2BlabradorDNSErrors8

StatusCodes200201304400401403404500Verbosemessages{"msg":

"verbose,plainlanguagehints"}VersioningIncludeversioninURL/v1/dogsKeepone

previousversionlongenoughfordeveloperstomigrate

/v1/dogs/v2/dogsClientConsiderationsClientdoesnotsupportHTTPstatuscodes?suppress_response_codes=trueClientdoesnotsupportHTTPmethodsGET/dogs?method=postGET/dogsGET/dogs?method=putGET/dogs?method=deleteComplementAPIwithSDKandcodelibraries1.JavaScript2.…3.…HowdowegetstartedwithourAPI?BuildanAPIModel/photos/brent_nashville/2156695472/in/photostream/Don’tGoCowboy/photos/theory/3364213389/in/photostream/HowdowesecureourAPI?Authorization:BasicaWhlYXJ0OmFwaXM=TwitterStreamingAPIAuthorization:AWSAKIAIOSFODNN7EXAMPLE:frJIUNo//yllqDzg=AmazonWebServicesAPIAuthorization:Bearer1/fFBGRNJru1FQd44AzqT3ZgGoogleAPI PreferredAuthorizationAuthorization:Bearer1/fFBGRNJru1FQd44AzqT3ZgOAuth2Howdoapproachmessagedesign?SupportmultipleformatsJSONandXMLMakeJSONthedefaultHowdowerepresentsingleitems?21TwitterFoursquare{

"meta":{…},"data":{}}

Instagram{

"meta":{…},

"notifications":

[…],

"response":{}}{"created_at":"ThuJan1008:44:59+00002013","id":289291736440791040,"id_str":"289291736440791040","text":"@landlessnesshere'soneforyou:50-yearplantofixDetroit\n\nhttp://t.co/kJ2l1FZv","source":"<ahref="/download/android"rel="nofollow">TwitterforAndroid</a>","truncated":false,"in_reply_to_status_id":null,"in_reply_to_status_id_str":null,"in_reply_to_user_id":41020312,"in_reply_to_user_id_str":"41020312","in_reply_to_screen_name":"landlessness","user":{…},"geo":{…},"coordinates":{…},"place":{…},"contributors”:{…},"retweet_count":0,"entities":{…},"favorited":false,"retweeted":false,"possibly_sensitive":false}22TwitterFoursquare{

"meta":{…},"data":{

"attribution":

{…},

"type":"image",

"location":

{…},

"comments":

{…},

"filter":"Sierra",

"created_time":

"1357826573",

"link":"http://instagr.am/p/UTk5Xut3gN/",

"likes":

{…},

"images":{…},

"caption":{…},

"user_has_liked":false,

"id":"365798266911553549_3573549",

"user":

{…}}}

Instagram{

"meta":{…},

"notifications":

[…],

"response":{

"checkin":{"id":"50eeff78e4b0f8e9624ea5f8",

"createdAt":1357840248,

"type":"checkin",

"shout":"Pharmacy#DRUGS!!!#ToothPulled:(",

"timeZone":"America/Detroit",

"timeZoneOffset":-300,

"user":{…},

"venue":{…},

"source":{…}

}

}}{"created_at":"ThuJan1008:44:59+00002013","id":289291736440791040,"id_str":"289291736440791040","text":"@landlessnesshere'soneforyou:50-yearplantofixDetroit\n\nhttp://t.co/kJ2l1FZv","source":"<ahref="/download/android"rel="nofollow">TwitterforAndroid</a>","truncated":false,"in_reply_to_status_id":null,"in_reply_to_status_id_str":null,"in_reply_to_user_id":41020312,"in_reply_to_user_id_str":"41020312","in_reply_to_screen_name":"landlessness","user":{…},"geo":{…},"coordinates":{…},"place":{…},"contributors”:{…},"retweet_count":0,"entities":{…},"favorited":false,"retweeted":false,"possibly_sensitive":false}23TakethebestofFoursquareandInstagram{

"meta":{…},

"dog":{…}"notifications":

[…],}Howdowerepresentcollections?25TwitterFoursquare{

"meta":{…},"data":[

{

"attribution":{…},

"type":"image",

"location":{…},

"comments":{…},

"filter":"Sierra",

"created_time":"1357826573",

"link":"http://instagr.am/p/UTk5Xut3gN/",

"likes":{…},

"images":{…},

"caption":{…},

"user_has_liked":false,

"id":"365798266911553549_3573549",

"user":{…}

},

{…},

{…}]}}

Instagram{

"meta":{…},

"notifications":

[…],

"response":{

"recent":[

{

"id":"50eeff78e4b0f8e9624ea5f8",

"createdAt":1357840248,

"type":"checkin",

"shout":"Pharmacy#DRUGS!!!#ToothPulled:(",

"timeZone":"America/Detroit",

"timeZoneOffset":-300,

"user":{…},

"venue":{…}

},

{…},

{…},]

}}[

{"created_at":"ThuJan1008:44:59+00002013","id":289291736440791040,"id_str":"289291736440791040","text":"@landlessnesshere'soneforyou:50-yearplantofixDetroit\n\nhttp://t.co/kJ2l1FZv","source":"<ahref="/download/android"rel="nofollow">TwitterforAndroid</a>","truncated":false,"in_reply_to_status_id":null,"in_reply_to_status_id_str":null,"in_reply_to_user_id":41020312,"in_reply_to_user_id_str":"41020312","in_reply_to_screen_name":"landlessness","user":{…},"geo":{…},"coordinates":{…},"place":{…},"contributors”:{…},"retweet_count":0,"entities":{…},"favorited":false,"retweeted":false,"possibly_sensitive":false},

{…},

{…}]26TakethebestofFoursquareandInstagram{

"meta":{…},"dogs":{…}/*includesameinfoassingle*/"notifications":

[…],}Howdowerepresentsearchresults?“Selectingresultsisnotthesameassearching.-FacebookAPI29BingSearchGoogleCustomSearch{"kind":"Listing","data":{"after":"t3_qy342","before":null,"children":[{"data":{"id":"f605o","num_comments":943,"score":1146,"ups":3110,"downs":1964,"created":1295553753.0,"url":"/r/AskReddit/comments/f605o/this_is_a_long_shot_any_sushi_chefs_need_a_job_in/","author":"jining",}},{"data":{"id":"c9eng”,"num_comments":308,"score":59,"ups":128,"downs":69,"created":1275155900.0,"url":"/r/IAmA/comments/c9eng/i_am_a_sushi_man_ama/","saved":false,"is_self":true,"permalink":"/r/IAmA/comments/c9eng/i_am_a_sushi_man_ama/","author":"IAmASushiMan”}}]}}

RedditSearch{"kind":"customsearch#search","url":{"type":"application/json","template":"/customsearch/v1?q={searchTerms}…},"queries":{"request":[{"title":"GoogleCustomSearch-sushi","totalResults":"15000000","searchTerms":"sushi","count":10,"startIndex":1,}]},"context":{"title":"CustomSearch"},"searchInformation":{"searchTime":0.314942,"formattedSearchTime":"0.31","totalResults":"15000000","formattedTotalResults":"15,000,000"},"items":[{"kind":"customsearch#result","title":"StandardizedUsageStatisticsHarvestingInitiative(SUSHI...-NISO","htmlTitle":"\u003cb\u003eStandardizedUsageStatisticsHarvestingInitiative\u003c/b\u003e(\u003cb\u003eSUSHI\u003c/b\u003e\u003cb\u003e...\u003c/b\u003e-NISO","link":"/workrooms/sushi","displayLink":"","snippet":"TheStandardizedUsageStatisticsHarvestingInitiative(SUSHI)Protocolstandard(ANSI/NISOZ39.93-2007)definesanautomatedrequestandresponsemodel...”,{

"SearchResponse":{"Version":"2.2","Query":{"SearchTerms":"sushi"},"Web":{"Total":95200000,"Offset":0,"Results":[{"Title":"TheSushiFAQ-Theultimateguidetosushiandsashimiandhowto...","Description":"Whatissushi?..","Url":"/","CacheUrl":"/cache.aspx?q=sushi&d=4855190808495712&w=yU8fJS-YPT-f4svREMW2xSa75OoBUAZR","DisplayUrl":"","DateTime":"2013-01-08T15:12:00Z"},{"Title":"WhatIsSushi?-SushiGuide-E","Description":"E...","Url":"/whatsushi.asp","CacheUrl":"/cache.aspx?q=sushi&d=5013249854931333&w=ihBzI9k9WbrnwxKcV3n8mOoV97M89K-b","DisplayUrl":"/whatsushi.asp","DateTime":"2013-01-07T13:51:00Z"}]}}}30(Mostly)FollowGoogleCustomSearch{"meta":{"limit":1,

"offset":10,

"totalResults":15000000,

"query":"sushi","searchTime":0.314942},

"results":[

{},{},

{}]}Howdowerepresentlinks?LinkingExamples<link

href=“http:///catalog/people/100637”rel=“http:///catalog/person.actor”title="ElijahWood”></link>NetflixAPI"organization":{

"login":"octocat",

"id":1,

"url":"https:///users/octocat",

"type":"Organization”}GitHubAPIPreferredLinking<link

href=“http:///catalog/people/100637”rel=“http:///catalog/person.actor”title="ElijahWood”></link>FollowNetflixandtheWebLinkingspecHowdowerepresentactions?ActionExamplesGitHub”actions":[{

“name”:“edit-repo”,

“method”:“PATCH”,

“href”:“/repos/kevinswiber/siren”,”fields”:[{“name”:“name”,“type”:“text”},

{“name”:“description”,“type”:“text”}}]Form-basedAPIPreferredAction"actions":[{

"name":"edit-repo",

“method”:“PATCH”,

“href”:“/repos/kevinswiber/siren”,”fields”:[{“name”:“name”,“type”:“text”},

{“name”:“description”,“type”:“text”}}]Form-basedAPIHowdowerepresentmetadata?PreferredMetadata<item

type="photo”

id="10289”server="2”views="47”

faves="0”

more="0">FlickrAPI(inline){

"size":"225.4KB”,

"rev":"35e97029684fe”,"bytes":230783,

"modified":"Tue,19Jul201121:55:38+0000”,

"path":"/Getting_Started.pdf”,

"is_dir":false,

"icon":"page_white_acrobat”,

"root":"dropbox”,

"mime_type":"application/pdf”,

"revision":220823}DropboxAPI(/metadata)Metadata

Examples39Includeametadatainresponsesandconsideradedicated/metaresource{

"meta":{

"size":"225.4KB”,"rev":"35e97029684fe”,"bytes":230783,"modified":"Tue,19Jul201121:55:38+0000”,"path":"/Getting_Started.pdf”,"is_dir":false,"icon":"page_white_acrobat”,"root":"dropbox”,"mime_type":"application/pdf”,"revision":220823

}}Whatcanwelearnfromhypermediatypes?Atom/AtomPub<?xmlversion="1.0"?><entryxmlns="http:///2005/Atom">

<title>MyNewCollection</title>

<id>urn:uuid:de46e3a1-e489-41a6-88a6-21e7f0e8e2d8</id>

<updated>2009-06-12T12:13:46Z</updated>

<author>

<name>Daffy</name>

</author>

<summarytype="text"/>

<contenttype="application/atom+xml;type=feed"

src="/my-new-collection"/><linkrel="edit”

href="/my-new-collection.atom"/></entry>XHTML<ulclass=“searchuser-list”>

<liclass=“user”>

<divclass="avatar">

<ahref="/users/@kevin">

<imgclass=”user-image"src=”/img/avatar.png"/>

</a>

</div>

<div>

<ahref=“/users/@kevin”rel=“usermessages”>

<spanclass=“user-name”>@kevin</span>

(<spanclass="user-text">@kevin</span>)

</a></div>

</li></ul>HAL{

“currentlyProcessing”:14“shippedToday”:20,

“_links”:{

“self”:{“href”:“/orders?page=2”},

“next”:{“href”:“/orders?page=3”},

“prev”:{“href”:“/orders?page=1”}

}}Collection+JSON{“collection”:

{

“version”:“1.0”,

“href”:“/friends”,“items”:[

“href”:“/friends/kevin”,

“data”:[

{“name”:“full-name”,“value”:“KevinSwiber”}

]],

“queries”:[

{“rel”:“search”,“href”:“./search”,“data”:[

{“name”:“search”,“value”:“”}

]

}}Siren{

“class”:[“owner”,“vip”],

“properties”:{

“name”:“Kevin”},

“entities”:[

{

“rel”:[“https://rels.x.io/dog”],

“href”:“https://api.x.io/dogs/1”}

],

“actions”:[

{

“name”:“adopt”,

“method”:“POST”,

“href”:“https://api.x.io/owners/1/dogs”,

“fields”:[{“name”:“dog-name”,“type”:“text”}]

}],

“links”:[

{“rel”:[“self”],“href”:“https://api.x.io/owners/1”}

]}Howdoweacceptbinarydata?multipart/form-dataContent-Type:multipart/form-data;boundary=AaB03x--AaB03xContent-Disposition:form-data;name=“caption”Coolpictureofmycat.--AaB03xContent-Disposition:form-data;name=“photo”;filename=“catpajamas.jpg”Content-Type:image/jpegContent-Transfer-Encoding:binary…contentsofcatpajamas.jpg…--AaB03xInlineBase64EncodingPOST/photos{

“caption”:“Coolpictureofmycat.”“photo”:“RHVkZSwgbXkgY2F0IGhhcyB0aGUgYmVzdCBwYWphbWFzLg==”}2-StepProcessPOST/photos{

“caption”:“Coolpicture