{"id":"https://openalex.org/W2993498920","doi":"https://doi.org/10.1109/icsme.2019.00052","title":"Inappropriate Usage Examples in Web API Documentations","display_name":"Inappropriate Usage Examples in Web API Documentations","alternate_titles":[],"publication_year":2019,"publication_date":"2019-09-01","ids":{"openalex":"https://openalex.org/W2993498920","doi":"https://doi.org/10.1109/icsme.2019.00052","mag":"2993498920"},"language":"en","primary_location":{"id":"doi:10.1109/icsme.2019.00052","doi":"https://doi.org/10.1109/icsme.2019.00052","is_oa":false,"landing_page_url":"https://doi.org/10.1109/icsme.2019.00052","pdf_url":null,"source":{"id":"https://openalex.org/S4210174939","display_name":"IEEE International Conference on Software Maintenance (ICSM)","issn_l":"1063-6773","issn":["1063-6773","2576-3148"],"is_oa":false,"is_in_doaj":false,"is_core":true,"listed_in":["cwts-core"],"host_organization":"https://openalex.org/P4310319808","host_organization_name":"Institute of Electrical and Electronics Engineers","host_organization_lineage":["https://openalex.org/P4310319808"],"host_organization_lineage_names":["Institute of Electrical and Electronics Engineers"],"type":"conference"},"license":null,"license_id":null,"version":"publishedVersion","is_accepted":true,"is_published":true,"raw_source_name":"2019 IEEE International Conference on Software Maintenance and Evolution (ICSME)","raw_type":"proceedings-article"},"parent_works":[],"lineage":["https://openalex.org/W2993498920"],"child_works_count":0,"type":"conference-paper","is_traditional":true,"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/A5041489835","display_name":"Masaki Hosono","orcid":null,"observed_orcids":[]},"institutions":[{"id":"https://openalex.org/I150744194","display_name":"Waseda University","ror":"https://ror.org/00ntfnx83","country_code":"JP","type":"education","lineage":["https://openalex.org/I150744194"]}],"countries":["JP"],"is_corresponding":false,"contributor_roles":[],"raw_author_name":"Masaki Hosono","raw_affiliation_strings":["Waseda University, Tokyo, Japan"],"raw_orcid":null,"affiliations":[{"raw_affiliation_string":"Waseda University, Tokyo, Japan","institution_ids":["https://openalex.org/I150744194"]}]},{"author_position":"middle","author":{"id":"https://openalex.org/A5103435667","display_name":"Susumu Tokumoto","orcid":null,"observed_orcids":[]},"institutions":[{"id":"https://openalex.org/I2252096349","display_name":"Fujitsu (Japan)","ror":"https://ror.org/038e2g226","country_code":"JP","type":"company","lineage":["https://openalex.org/I2252096349"]}],"countries":["JP"],"is_corresponding":false,"contributor_roles":[],"raw_author_name":"Susumu Tokumoto","raw_affiliation_strings":["Fujitsu Laboratories Ltd.,, Kawasaki, Japan"],"raw_orcid":null,"affiliations":[{"raw_affiliation_string":"Fujitsu Laboratories Ltd.,, Kawasaki, Japan","institution_ids":["https://openalex.org/I2252096349"]}]},{"author_position":"middle","author":{"id":"https://openalex.org/A5066990725","display_name":"Supasit Monpratarnchai","orcid":null,"observed_orcids":[]},"institutions":[{"id":"https://openalex.org/I2252096349","display_name":"Fujitsu (Japan)","ror":"https://ror.org/038e2g226","country_code":"JP","type":"company","lineage":["https://openalex.org/I2252096349"]}],"countries":["JP"],"is_corresponding":false,"contributor_roles":[],"raw_author_name":"Supasit Monpratarnchai","raw_affiliation_strings":["Formerly Fujitsu Laboratories Ltd"],"raw_orcid":null,"affiliations":[{"raw_affiliation_string":"Formerly Fujitsu Laboratories Ltd","institution_ids":["https://openalex.org/I2252096349"]}]},{"author_position":"middle","author":{"id":"https://openalex.org/A5033111691","display_name":"Hironori Washizaki","orcid":"https://orcid.org/0000-0002-1417-9879","observed_orcids":["https://orcid.org/0000-0002-1417-9879"]},"institutions":[{"id":"https://openalex.org/I150744194","display_name":"Waseda University","ror":"https://ror.org/00ntfnx83","country_code":"JP","type":"education","lineage":["https://openalex.org/I150744194"]}],"countries":["JP"],"is_corresponding":false,"contributor_roles":[],"raw_author_name":"Hironori Washizaki","raw_affiliation_strings":["Waseda University, Tokyo, Japan"],"raw_orcid":null,"affiliations":[{"raw_affiliation_string":"Waseda University, Tokyo, Japan","institution_ids":["https://openalex.org/I150744194"]}]},{"author_position":"middle","author":{"id":null,"display_name":"Kiyoshi Honda","orcid":null,"observed_orcids":[]},"institutions":[{"id":"https://openalex.org/I150744194","display_name":"Waseda University","ror":"https://ror.org/00ntfnx83","country_code":"JP","type":"education","lineage":["https://openalex.org/I150744194"]}],"countries":["JP"],"is_corresponding":false,"contributor_roles":[],"raw_author_name":"Kiyoshi Honda","raw_affiliation_strings":["Waseda University, Tokyo, Japan"],"raw_orcid":null,"affiliations":[{"raw_affiliation_string":"Waseda University, Tokyo, Japan","institution_ids":["https://openalex.org/I150744194"]}]},{"author_position":"middle","author":{"id":"https://openalex.org/A5043621745","display_name":"Hiromasa Nagumo","orcid":null,"observed_orcids":[]},"institutions":[{"id":"https://openalex.org/I150744194","display_name":"Waseda University","ror":"https://ror.org/00ntfnx83","country_code":"JP","type":"education","lineage":["https://openalex.org/I150744194"]}],"countries":["JP"],"is_corresponding":false,"contributor_roles":[],"raw_author_name":"Hiromasa Nagumo","raw_affiliation_strings":["Waseda University, Tokyo, Japan"],"raw_orcid":null,"affiliations":[{"raw_affiliation_string":"Waseda University, Tokyo, Japan","institution_ids":["https://openalex.org/I150744194"]}]},{"author_position":"middle","author":{"id":"https://openalex.org/A5063903918","display_name":"Hisanobu Sonoda","orcid":null,"observed_orcids":[]},"institutions":[{"id":"https://openalex.org/I150744194","display_name":"Waseda University","ror":"https://ror.org/00ntfnx83","country_code":"JP","type":"education","lineage":["https://openalex.org/I150744194"]}],"countries":["JP"],"is_corresponding":false,"contributor_roles":[],"raw_author_name":"Hisanobu Sonoda","raw_affiliation_strings":["Waseda University, Tokyo, Japan"],"raw_orcid":null,"affiliations":[{"raw_affiliation_string":"Waseda University, Tokyo, Japan","institution_ids":["https://openalex.org/I150744194"]}]},{"author_position":"middle","author":{"id":"https://openalex.org/A5088654194","display_name":"Yoshiaki Fukazawa","orcid":"https://orcid.org/0000-0003-0196-2108","observed_orcids":["https://orcid.org/0000-0003-0196-2108"]},"institutions":[{"id":"https://openalex.org/I150744194","display_name":"Waseda University","ror":"https://ror.org/00ntfnx83","country_code":"JP","type":"education","lineage":["https://openalex.org/I150744194"]}],"countries":["JP"],"is_corresponding":false,"contributor_roles":[],"raw_author_name":"Yoshiaki Fukazawa","raw_affiliation_strings":["Waseda University, Tokyo, Japan"],"raw_orcid":null,"affiliations":[{"raw_affiliation_string":"Waseda University, Tokyo, Japan","institution_ids":["https://openalex.org/I150744194"]}]},{"author_position":"middle","author":{"id":"https://openalex.org/A5060738878","display_name":"Kazuki Munakata","orcid":"https://orcid.org/0009-0005-8286-448X","observed_orcids":["https://orcid.org/0009-0005-8286-448X"]},"institutions":[{"id":"https://openalex.org/I2252096349","display_name":"Fujitsu (Japan)","ror":"https://ror.org/038e2g226","country_code":"JP","type":"company","lineage":["https://openalex.org/I2252096349"]}],"countries":["JP"],"is_corresponding":false,"contributor_roles":[],"raw_author_name":"Kazuki Munakata","raw_affiliation_strings":["Fujitsu Laboratories Ltd.,, Kawasaki, Japan"],"raw_orcid":null,"affiliations":[{"raw_affiliation_string":"Fujitsu Laboratories Ltd.,, Kawasaki, Japan","institution_ids":["https://openalex.org/I2252096349"]}]},{"author_position":"middle","author":{"id":null,"display_name":"Takao Nakagawa","orcid":null,"observed_orcids":[]},"institutions":[{"id":"https://openalex.org/I2252096349","display_name":"Fujitsu (Japan)","ror":"https://ror.org/038e2g226","country_code":"JP","type":"company","lineage":["https://openalex.org/I2252096349"]}],"countries":["JP"],"is_corresponding":false,"contributor_roles":[],"raw_author_name":"Takao Nakagawa","raw_affiliation_strings":["Fujitsu Laboratories Ltd.,, Kawasaki, Japan"],"raw_orcid":null,"affiliations":[{"raw_affiliation_string":"Fujitsu Laboratories Ltd.,, Kawasaki, Japan","institution_ids":["https://openalex.org/I2252096349"]}]},{"author_position":"last","author":{"id":null,"display_name":"Yusuke Nemoto","orcid":null,"observed_orcids":[]},"institutions":[{"id":"https://openalex.org/I2252096349","display_name":"Fujitsu (Japan)","ror":"https://ror.org/038e2g226","country_code":"JP","type":"company","lineage":["https://openalex.org/I2252096349"]}],"countries":["JP"],"is_corresponding":false,"contributor_roles":[],"raw_author_name":"Yusuke Nemoto","raw_affiliation_strings":["Fujitsu Laboratories Ltd.,, Kawasaki, Japan"],"raw_orcid":null,"affiliations":[{"raw_affiliation_string":"Fujitsu Laboratories Ltd.,, Kawasaki, Japan","institution_ids":["https://openalex.org/I2252096349"]}]}],"institutions":[],"countries_distinct_count":1,"institutions_distinct_count":2,"corresponding_author_ids":[],"corresponding_institution_ids":[],"apc_list":null,"apc_paid":null,"fwci":0.0,"has_fulltext":false,"cited_by_count":2,"citation_normalized_percentile":{"value":0.0,"is_in_top_1_percent":false,"is_in_top_10_percent":false},"cited_by_percentile_year":{"min":89,"max":95},"biblio":{"volume":null,"issue":null,"first_page":"343","last_page":"347"},"is_retracted":false,"is_pulled":false,"is_paratext":false,"is_xpac":false,"primary_topic":{"id":"https://openalex.org/T10260","display_name":"Software Engineering Research","score":0.9785000085830688,"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.9785000085830688,"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/T10679","display_name":"Service-Oriented Architecture and Web Services","score":0.011500000022351742,"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/T12799","display_name":"Mobile and Web Applications","score":0.0024999999441206455,"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"}}],"keywords":[{"id":"https://openalex.org/keywords/api-documentation","display_name":"API documentation","score":0.675000011920929},{"id":"https://openalex.org/keywords/usage-examples","display_name":"usage examples","score":0.7799999713897705},{"id":"https://openalex.org/keywords/openapi","display_name":"OpenAPI","score":0.8579999804496765},{"id":"https://openalex.org/keywords/dynamic-key","display_name":"dynamic key","score":0.7409999966621399},{"id":"https://openalex.org/keywords/web-api","display_name":"web API","score":0.4180000126361847}],"concepts":[{"id":"https://openalex.org/C56666940","wikidata":"https://www.wikidata.org/wiki/Q788790","display_name":"Documentation","level":2,"score":0.8278905749320984},{"id":"https://openalex.org/C41008148","wikidata":"https://www.wikidata.org/wiki/Q21198","display_name":"Computer science","level":0,"score":0.7847763895988464},{"id":"https://openalex.org/C99613125","wikidata":"https://www.wikidata.org/wiki/Q165194","display_name":"Application programming interface","level":2,"score":0.7721612453460693},{"id":"https://openalex.org/C206588197","wikidata":"https://www.wikidata.org/wiki/Q846574","display_name":"Reuse","level":2,"score":0.5280709266662598},{"id":"https://openalex.org/C136764020","wikidata":"https://www.wikidata.org/wiki/Q466","display_name":"World Wide Web","level":1,"score":0.4892694652080536},{"id":"https://openalex.org/C81587897","wikidata":"https://www.wikidata.org/wiki/Q181702","display_name":"Software documentation","level":5,"score":0.4141917824745178},{"id":"https://openalex.org/C2777904410","wikidata":"https://www.wikidata.org/wiki/Q7397","display_name":"Software","level":2,"score":0.41208139061927795},{"id":"https://openalex.org/C529173508","wikidata":"https://www.wikidata.org/wiki/Q638608","display_name":"Software development","level":3,"score":0.24941083788871765},{"id":"https://openalex.org/C180152950","wikidata":"https://www.wikidata.org/wiki/Q2904257","display_name":"Software development process","level":4,"score":0.15626272559165955},{"id":"https://openalex.org/C199360897","wikidata":"https://www.wikidata.org/wiki/Q9143","display_name":"Programming language","level":1,"score":0.12037283182144165},{"id":"https://openalex.org/C127413603","wikidata":"https://www.wikidata.org/wiki/Q11023","display_name":"Engineering","level":0,"score":0.07921656966209412},{"id":"https://openalex.org/C548081761","wikidata":"https://www.wikidata.org/wiki/Q180388","display_name":"Waste management","level":1,"score":0.0}],"mesh":[],"locations_count":1,"locations":[{"id":"doi:10.1109/icsme.2019.00052","doi":"https://doi.org/10.1109/icsme.2019.00052","is_oa":false,"landing_page_url":"https://doi.org/10.1109/icsme.2019.00052","pdf_url":null,"source":{"id":"https://openalex.org/S4210174939","display_name":"IEEE International Conference on Software Maintenance (ICSM)","issn_l":"1063-6773","issn":["1063-6773","2576-3148"],"is_oa":false,"is_in_doaj":false,"is_core":true,"listed_in":["cwts-core"],"host_organization":"https://openalex.org/P4310319808","host_organization_name":"Institute of Electrical and Electronics Engineers","host_organization_lineage":["https://openalex.org/P4310319808"],"host_organization_lineage_names":["Institute of Electrical and Electronics Engineers"],"type":"conference"},"license":null,"license_id":null,"version":"publishedVersion","is_accepted":true,"is_published":true,"raw_source_name":"2019 IEEE International Conference on Software Maintenance and Evolution (ICSME)","raw_type":"proceedings-article"}],"best_oa_location":null,"sustainable_development_goals":[],"study_designs":[],"awards":[],"funders":[],"has_content":{"grobid_xml":false,"pdf":false},"content_urls":null,"referenced_works_count":14,"referenced_works":["https://openalex.org/W1884204318","https://openalex.org/W1990693033","https://openalex.org/W2008107570","https://openalex.org/W2048733335","https://openalex.org/W2092513324","https://openalex.org/W2123333323","https://openalex.org/W2147111361","https://openalex.org/W2148469619","https://openalex.org/W2395092677","https://openalex.org/W2605695983","https://openalex.org/W2614536965","https://openalex.org/W2716494494","https://openalex.org/W2771030034","https://openalex.org/W2949308271"],"related_works":["https://openalex.org/W2946645460","https://openalex.org/W2771030034","https://openalex.org/W4285191371","https://openalex.org/W2089016727","https://openalex.org/W3089601380","https://openalex.org/W1884204318","https://openalex.org/W2044527216","https://openalex.org/W2554251271","https://openalex.org/W3003039602","https://openalex.org/W2716494494"],"abstract_inverted_index":{"Application":[0],"Programming":[1],"Interfaces":[2],"(APIs)":[3],"are":[4,65],"common":[5],"in":[6,37,91,115],"software":[7],"development":[8],"to":[9,19],"reuse":[10],"other":[11],"products.":[12],"Although":[13],"the":[14,31,54,87,92,97],"documentation":[15,40,114],"allows":[16],"API":[17,22,39,106],"consumers":[18,109],"learn":[20],"about":[21],"usages,":[23],"it":[24],"can":[25],"be":[26],"unreliable.":[27],"Here,":[28],"we":[29],"investigate":[30],"characteristics":[32],"of":[33,53,59,89,99],"inappropriate":[34,60],"usage":[35,48,61],"examples":[36],"web":[38,116],"by":[41],"extracting":[42],"and":[43,79,108],"comparing":[44],"OpenAPI":[45],"Specifications":[46],"from":[47],"example-response":[49],"pairs.":[50],"About":[51],"65.5%":[52],"endpoints":[55],"have":[56],"some":[57],"form":[58],"examples.":[62],"Furthermore,":[63],"mismatches":[64],"classified":[66],"into":[67],"four":[68],"categories:":[69],"undocumented":[70],"keys":[71,74,77,90],"pattern,":[72,75,78],"dynamic":[73],"unreturned":[76],"type":[80],"mismatched":[81],"pattern.":[82],"Our":[83],"results":[84],"suggest":[85],"that":[86],"number":[88,98],"response":[93],"is":[94],"correlated":[95],"with":[96,112],"mismatches.":[100],"These":[101],"findings":[102],"should":[103],"assist":[104],"both":[105],"providers":[107],"who":[110],"deal":[111],"unreliable":[113],"APIs.":[117]},"cited_by_api_url":"https://api.openalex.org/works?filter=cites:W2993498920","counts_by_year":[{"year":2026,"cited_by_count":1},{"year":2025,"cited_by_count":1}],"updated_date":"2026-11-04T10:54:05.112534","created_date":"2019-12-13T00:00:00"}
