{"id":"https://openalex.org/W2771030034","doi":"https://doi.org/10.1109/vlhcc.2017.8103450","title":"A study of the effectiveness of usage examples in REST API documentation","display_name":"A study of the effectiveness of usage examples in REST API documentation","publication_year":2017,"publication_date":"2017-10-01","ids":{"openalex":"https://openalex.org/W2771030034","doi":"https://doi.org/10.1109/vlhcc.2017.8103450","mag":"2771030034"},"language":"en","primary_location":{"id":"doi:10.1109/vlhcc.2017.8103450","is_oa":false,"landing_page_url":"https://doi.org/10.1109/vlhcc.2017.8103450","pdf_url":null,"source":null,"license":null,"license_id":null,"version":"publishedVersion","is_accepted":true,"is_published":true,"raw_source_name":"2017 IEEE Symposium on Visual Languages and Human-Centric Computing (VL/HCC)","raw_type":"proceedings-article"},"type":"article","indexed_in":["crossref"],"open_access":{"is_oa":false,"oa_status":"closed","oa_url":null,"any_repository_has_fulltext":false},"authorships":[{"author_position":"first","author":{"id":"https://openalex.org/A5046565308","display_name":"S. M. Sohan","orcid":null},"institutions":[{"id":"https://openalex.org/I168635309","display_name":"University of Calgary","ror":"https://ror.org/03yjb2x39","country_code":"CA","type":"education","lineage":["https://openalex.org/I168635309"]}],"countries":["CA"],"is_corresponding":true,"raw_author_name":"S M Sohan","raw_affiliation_strings":["Dept. of Computer Science, University of Calgary, Canada"],"affiliations":[{"raw_affiliation_string":"Dept. of Computer Science, University of Calgary, Canada","institution_ids":["https://openalex.org/I168635309"]}]},{"author_position":"middle","author":{"id":"https://openalex.org/A5070105322","display_name":"Frank Maurer","orcid":"https://orcid.org/0000-0002-0240-715X"},"institutions":[{"id":"https://openalex.org/I168635309","display_name":"University of Calgary","ror":"https://ror.org/03yjb2x39","country_code":"CA","type":"education","lineage":["https://openalex.org/I168635309"]}],"countries":["CA"],"is_corresponding":false,"raw_author_name":"Frank Maurer","raw_affiliation_strings":["Dept. of Computer Science, University of Calgary, Canada"],"affiliations":[{"raw_affiliation_string":"Dept. of Computer Science, University of Calgary, Canada","institution_ids":["https://openalex.org/I168635309"]}]},{"author_position":"middle","author":{"id":"https://openalex.org/A5049285663","display_name":"Craig Anslow","orcid":"https://orcid.org/0000-0001-8064-6300"},"institutions":[{"id":"https://openalex.org/I41156924","display_name":"Victoria University of Wellington","ror":"https://ror.org/0040r6f76","country_code":"NZ","type":"education","lineage":["https://openalex.org/I41156924"]}],"countries":["NZ"],"is_corresponding":false,"raw_author_name":"Craig Anslow","raw_affiliation_strings":["School of Eng. and Computer Science, Victoria University of Wellington, New Zealand"],"affiliations":[{"raw_affiliation_string":"School of Eng. and Computer Science, Victoria University of Wellington, New Zealand","institution_ids":["https://openalex.org/I41156924"]}]},{"author_position":"last","author":{"id":"https://openalex.org/A5059244952","display_name":"Martin P. Robillard","orcid":"https://orcid.org/0000-0002-0248-1384"},"institutions":[{"id":"https://openalex.org/I5023651","display_name":"McGill University","ror":"https://ror.org/01pxwe438","country_code":"CA","type":"education","lineage":["https://openalex.org/I5023651"]}],"countries":["CA"],"is_corresponding":false,"raw_author_name":"Martin P. Robillard","raw_affiliation_strings":["School of Computer Science McGill University, Canada"],"affiliations":[{"raw_affiliation_string":"School of Computer Science McGill University, Canada","institution_ids":["https://openalex.org/I5023651"]}]}],"institutions":[],"countries_distinct_count":2,"institutions_distinct_count":4,"corresponding_author_ids":["https://openalex.org/A5046565308"],"corresponding_institution_ids":["https://openalex.org/I168635309"],"apc_list":null,"apc_paid":null,"fwci":7.2544,"has_fulltext":false,"cited_by_count":55,"citation_normalized_percentile":{"value":0.9723868,"is_in_top_1_percent":false,"is_in_top_10_percent":true},"cited_by_percentile_year":{"min":95,"max":99},"biblio":{"volume":null,"issue":null,"first_page":"53","last_page":"61"},"is_retracted":false,"is_paratext":false,"is_xpac":false,"primary_topic":{"id":"https://openalex.org/T10260","display_name":"Software Engineering Research","score":0.9998000264167786,"subfield":{"id":"https://openalex.org/subfields/1710","display_name":"Information Systems"},"field":{"id":"https://openalex.org/fields/17","display_name":"Computer Science"},"domain":{"id":"https://openalex.org/domains/3","display_name":"Physical Sciences"}},"topics":[{"id":"https://openalex.org/T10260","display_name":"Software Engineering Research","score":0.9998000264167786,"subfield":{"id":"https://openalex.org/subfields/1710","display_name":"Information Systems"},"field":{"id":"https://openalex.org/fields/17","display_name":"Computer Science"},"domain":{"id":"https://openalex.org/domains/3","display_name":"Physical Sciences"}},{"id":"https://openalex.org/T10639","display_name":"Advanced Software Engineering Methodologies","score":0.9973999857902527,"subfield":{"id":"https://openalex.org/subfields/1702","display_name":"Artificial Intelligence"},"field":{"id":"https://openalex.org/fields/17","display_name":"Computer Science"},"domain":{"id":"https://openalex.org/domains/3","display_name":"Physical Sciences"}},{"id":"https://openalex.org/T12127","display_name":"Software System Performance and Reliability","score":0.9968000054359436,"subfield":{"id":"https://openalex.org/subfields/1705","display_name":"Computer Networks and Communications"},"field":{"id":"https://openalex.org/fields/17","display_name":"Computer Science"},"domain":{"id":"https://openalex.org/domains/3","display_name":"Physical Sciences"}}],"keywords":[{"id":"https://openalex.org/keywords/documentation","display_name":"Documentation","score":0.9314109086990356},{"id":"https://openalex.org/keywords/computer-science","display_name":"Computer science","score":0.7618540525436401},{"id":"https://openalex.org/keywords/software-documentation","display_name":"Software documentation","score":0.5566408038139343},{"id":"https://openalex.org/keywords/rest","display_name":"Rest (music)","score":0.553747296333313},{"id":"https://openalex.org/keywords/application-programming-interface","display_name":"Application programming interface","score":0.5075894594192505},{"id":"https://openalex.org/keywords/software-engineering","display_name":"Software engineering","score":0.4524986147880554},{"id":"https://openalex.org/keywords/world-wide-web","display_name":"World Wide Web","score":0.4276931583881378},{"id":"https://openalex.org/keywords/software","display_name":"Software","score":0.38612738251686096},{"id":"https://openalex.org/keywords/operating-system","display_name":"Operating system","score":0.21175616979599},{"id":"https://openalex.org/keywords/software-development","display_name":"Software development","score":0.20487424731254578},{"id":"https://openalex.org/keywords/software-development-process","display_name":"Software development process","score":0.16173315048217773}],"concepts":[{"id":"https://openalex.org/C56666940","wikidata":"https://www.wikidata.org/wiki/Q788790","display_name":"Documentation","level":2,"score":0.9314109086990356},{"id":"https://openalex.org/C41008148","wikidata":"https://www.wikidata.org/wiki/Q21198","display_name":"Computer science","level":0,"score":0.7618540525436401},{"id":"https://openalex.org/C81587897","wikidata":"https://www.wikidata.org/wiki/Q181702","display_name":"Software documentation","level":5,"score":0.5566408038139343},{"id":"https://openalex.org/C77265313","wikidata":"https://www.wikidata.org/wiki/Q879844","display_name":"Rest (music)","level":2,"score":0.553747296333313},{"id":"https://openalex.org/C99613125","wikidata":"https://www.wikidata.org/wiki/Q165194","display_name":"Application programming interface","level":2,"score":0.5075894594192505},{"id":"https://openalex.org/C115903868","wikidata":"https://www.wikidata.org/wiki/Q80993","display_name":"Software engineering","level":1,"score":0.4524986147880554},{"id":"https://openalex.org/C136764020","wikidata":"https://www.wikidata.org/wiki/Q466","display_name":"World Wide Web","level":1,"score":0.4276931583881378},{"id":"https://openalex.org/C2777904410","wikidata":"https://www.wikidata.org/wiki/Q7397","display_name":"Software","level":2,"score":0.38612738251686096},{"id":"https://openalex.org/C111919701","wikidata":"https://www.wikidata.org/wiki/Q9135","display_name":"Operating system","level":1,"score":0.21175616979599},{"id":"https://openalex.org/C529173508","wikidata":"https://www.wikidata.org/wiki/Q638608","display_name":"Software development","level":3,"score":0.20487424731254578},{"id":"https://openalex.org/C180152950","wikidata":"https://www.wikidata.org/wiki/Q2904257","display_name":"Software development process","level":4,"score":0.16173315048217773},{"id":"https://openalex.org/C164705383","wikidata":"https://www.wikidata.org/wiki/Q10379","display_name":"Cardiology","level":1,"score":0.0},{"id":"https://openalex.org/C71924100","wikidata":"https://www.wikidata.org/wiki/Q11190","display_name":"Medicine","level":0,"score":0.0}],"mesh":[],"locations_count":1,"locations":[{"id":"doi:10.1109/vlhcc.2017.8103450","is_oa":false,"landing_page_url":"https://doi.org/10.1109/vlhcc.2017.8103450","pdf_url":null,"source":null,"license":null,"license_id":null,"version":"publishedVersion","is_accepted":true,"is_published":true,"raw_source_name":"2017 IEEE Symposium on Visual Languages and Human-Centric Computing (VL/HCC)","raw_type":"proceedings-article"}],"best_oa_location":null,"sustainable_development_goals":[{"id":"https://metadata.un.org/sdg/8","score":0.44999998807907104,"display_name":"Decent work and economic growth"}],"awards":[],"funders":[],"has_content":{"pdf":false,"grobid_xml":false},"content_urls":null,"referenced_works_count":21,"referenced_works":["https://openalex.org/W1610478983","https://openalex.org/W1858986506","https://openalex.org/W1884204318","https://openalex.org/W1975976188","https://openalex.org/W1991613282","https://openalex.org/W1994829522","https://openalex.org/W2008107570","https://openalex.org/W2020593163","https://openalex.org/W2024683376","https://openalex.org/W2025945315","https://openalex.org/W2033025900","https://openalex.org/W2051204868","https://openalex.org/W2077694039","https://openalex.org/W2089016727","https://openalex.org/W2114315419","https://openalex.org/W2119855409","https://openalex.org/W2164803710","https://openalex.org/W2366532918","https://openalex.org/W3151410988","https://openalex.org/W6652288661","https://openalex.org/W6658787343"],"related_works":["https://openalex.org/W1975647310","https://openalex.org/W2148507008","https://openalex.org/W2033083755","https://openalex.org/W2884925033","https://openalex.org/W2070076995","https://openalex.org/W2764664989","https://openalex.org/W2955439455","https://openalex.org/W4244946961","https://openalex.org/W2915114672","https://openalex.org/W2073875337"],"abstract_inverted_index":{"Generating":[0],"and":[1,14,115,143],"maintaining":[2],"REST":[3,21,43,83,98,126,133],"API":[4,22,32,44,84,91,99,127,134,146],"documentation":[5,23,29,59,63,119,128],"with":[6,74,105],"usage":[7,40,55,93,121],"examples":[8,56],"can":[9,136],"be":[10],"a":[11,71],"time":[12],"consuming":[13],"expensive":[15],"process":[16],"for":[17,38],"evolving":[18],"APIs.":[19],"Most":[20],"tools":[24],"focus":[25],"on":[26],"automating":[27],"the":[28,31,49,58,62,125,138],"of":[30,53,145],"objects,":[33],"but":[34],"require":[35],"manual":[36],"effort":[37],"capturing":[39],"examples.":[41,94,122],"Consequently,":[42],"developers":[45,86,101,135],"need":[46],"to":[47,60,79],"know":[48],"cost":[50],"vs.":[51],"benefit":[52],"providing":[54],"in":[57],"prioritize":[61],"efforts.":[64],"To":[65],"this":[66,131],"end,":[67],"we":[68],"have":[69],"performed":[70],"controlled":[72],"study":[73],"26":[75],"experienced":[76],"software":[77],"engineers":[78],"understand":[80],"problems":[81,104],"that":[82,97],"client":[85,100,147],"face":[87,102],"while":[88],"using":[89,106],"an":[90],"without":[92],"We":[95],"found":[96],"productivity":[103],"correct":[107],"data":[108,110],"types,":[109],"formats,":[111],"required":[112],"HTTP":[113],"headers":[114],"request":[116],"body":[117],"when":[118],"lacks":[120],"By":[123],"following":[124],"suggestions":[129],"from":[130],"paper,":[132],"reduce":[137],"errors,":[139],"improve":[140],"success":[141],"rate":[142],"satisfaction":[144],"developers.":[148]},"counts_by_year":[{"year":2025,"cited_by_count":2},{"year":2024,"cited_by_count":6},{"year":2023,"cited_by_count":14},{"year":2022,"cited_by_count":5},{"year":2021,"cited_by_count":13},{"year":2020,"cited_by_count":6},{"year":2019,"cited_by_count":4},{"year":2018,"cited_by_count":5}],"updated_date":"2025-11-06T03:46:38.306776","created_date":"2025-10-10T00:00:00"}