• No results found

Personliga reflektioner

In document Verktyg För Apidokumentation (Page 65-70)

Arbetet har varit ett givande sätt för oss att lära oss JavaScript tillsammans med ett populärt gränssnitt som React. Med hänvisning till undersökningen i kapitel 1.1 är det lätt att se varför så många utvecklare vill jobba med React - det är smidigt, finns bra dokumentation och det är kul att få feedback på koden direkt i form av en front-endkopplad webbsida. Däremot tog det lite tid att komma in i det då ingen av oss tidigare har jobbat med JavaScript, men vi tycker att det gav utdelning på det sätt att vi fick erfarenhet av “full stack”-arbete, det vill säga att vi fick arbeta med både front-end och back-front-end.

Något som var förvånande för oss var hur enkelt det var att integrera React-komponenter i Markdown. Det gjorde att vi kunde gå långt över den initiala avgränsningen som sattes i början av projektet - att verktyget endast skulle ha stöd för samtliga artikelanrop. Detta

gör att Askås enkelt kan bygga vidare på de komponenter vi har utvecklat genom att bara skriva en Markdown-fil med det anrop som ska stödjas. Projektet har givit en inblick i hur en dag ser ut på Askås kontor och framför allt hur arbetslivet ser ut inom detta område och vikten av att känna till JavaScript och React. En intressant aspekt till detta arbete är att det verktyg som utvecklats är något som kommer att komma till nytta och användas, vilket är en stor anledning till varför vi var intresserade av detta projekt.

Litteratur

[1] eBay Developers Program. Accessed: 2021-05-05.URL: https://developer.

ebay.com/common/api?mkevt=1&mkcid=1&mkrid=711- 53200-19255-0&campid=5337590774&customid=&toolid=10001.

[2] Art Anthony. Tracking the Growth of the API Economy: Nordic APIs. Accessed 2021-05-05. April 2016. URL: https://nordicapis.com/tracking- the-growth-of-the-api-economy/.

[3] Santos Wendell. APIs show Faster Growth Rate in 2019 than Previous Years.

Accessed 2021-04-28. Juli 2019. URL: https : / / www . programmableweb . com / news / apis - show - faster - growth - rate - 2019 - previous - years / research/2019/07/17.

[4] Martin P Robillard. “What makes APIs hard to learn? Answers from developers”.

I: IEEE software 26.6 (2009), s. 27–34.

[5] Vasudevan Keshav. What Is API Documentation, and Why It Matters? Accessed 2021-02-19. Juni 2017.URL: https://swagger.io/blog/api-documentation/

what-is-api-documentation-and-why-it-matters/.

[6] Stack Overflow Developer Survey 2020. Accessed: 2021-04-29. URL: https : //insights.stackoverflow.com/survey/2020.

[7] Danillo Corvalan, Doel Sengupta och Manu Singhal. Getting Started with React.

Packt Publishing, 2016.

53

[8] Built With. React Usage Statistics. Accessed 2021-04-28.URL: https://trends.

builtwith.com/javascript/React.

[9] John Otander m. fl. Markdown for the component era. Accessed 2021-04-29.

URL: https://mdxjs.com/.

[10] Välkommen till oss på Askås. Accessed: 2021-03-18. URL: https : / / www . askas.se/sv/om-askas.html.

[11] Askås 20 years of e-commerce experience. Accessed: 2021-03-18.URL: https:

//www.kau.se/index.php/en/cs/news/askas-20-years-e-commerce-experience.

[12] Askås storsatsar anställer helt fotbollslag". Accessed: 2021-03-18.URL: https:

//www.askas.se/sv/nyheter-fran-askas/askas-anstaller-elva-nya-medarbetare.html.

[13] Application programming interface. Accessed: 2021-03-25.URL: https://en.

wikipedia . org / wiki / Application _ programming _ interface ? oldid = 673710319 & fbclid = IwAR18d6dM6BHVR13U0Lw0z66Wc5kEvIVWQFQqq _ 6K -Z1X1G_VEeXQ24cOwUg.

[14] C Rudrakshi m. fl. API-fication-core building block of the digital enterprise. Tekn.

rapport. Technical report, HCL Technologies, 2014.URL: https://www.hcltech.

com/sites/default/files/apis_for_dsi.pdf.

[15] Vasudevan Keshav. The Path to a Successful API. Accessed 2021-02-18. Nov.

2016. URL: https : / / swagger . io / blog / api strategy / building a -successful-api/.

[16] Martin P Robillard och Robert DeLine. “A field study of API learning obstacles”.

I: Empirical Software Engineering 16.6 (2011), s. 703–732.

LITTERATUR 55 [17] Michael Meng, Stephanie Steinhardt och Andreas Schubert. “Application pro-gramming interface documentation: what do software developers want?” I: Jour-nal of Technical Writing and Communication 48.3 (2018), s. 295–330.

[18] Qiang Fan m. fl. “Why API documentation is insufficient for developers: an em-pirical study”. I: Science China Information Sciences 64.1 (2021), s. 1–3.

[19] W3schools. React Components. Accessed 2021-02-25. URL: https : / / www . w3schools.com/react/react_components.asp.

[20] Artemij Fedosejev. React.js essentials. Packt Publishing Ltd, 2015.

[21] React - A JavaScript library for building user interfaces. Accessed: 2021-02-18.

2021.URL: https://reactjs.org.

[22] Web technology for developers. Accessed: 2021-02-19.URL: https://developer.

mozilla.org/en-US/docs/Web/API/Document_Object_Model.

[23] Reconciliation. Accessed: 2021-02-19. URL: https : / / reactjs . org / docs / reconciliation.html.

[24] Cory Gackenheimer. Introduction to React. Apress, 2015.

[25] Rendering Elements. Accessed 2021-02-18. URL: https : / / reactjs . org / docs/rendering-elements.html#gatsby-focus-wrapper.

[26] Jens Voegler, Jens Bornschein och Gerhard Weber. “Markdown–A simple syntax for transcription of accessible study materials”. I: International Conference on Computers for Handicapped Persons. Springer. 2014, s. 545–548.

[27] Using React. Accessed: 2021-02-27. URL: https://docusaurus.io/docs/

markdown-features/react.

[28] Build optimized websites quickly, focus on your content: Docusaurus. Accessed:

2021-01-29.URL: https://docusaurus.io/.

[29] Node.js. About Node.js. Accessed: 2021-01-29.URL: https://nodejs.org/

en/about/.

[30] Introduction to Node.js. Accessed: 2021-01-29. URL: https://nodejs.dev/

learn.

[31] Robert B Watson. “Development and application of a heuristic to assess trends in API documentation”. I: Proceedings of the 30th ACM international conference on Design of communication. 2012, s. 295–302.

[32] Michael Meng, Stephanie M Steinhardt och Andreas Schubert. “Optimizing API Documentation: Some Guidelines and Effects”. I: Proceedings of the 38th ACM International Conference on Design of Communication. Department of Business Studies and Information Sciences, Merseburg University of Applied Sciences, Merseburg, Germany. 2020, s. 1–11.

[33] About npm. Accessed: 2021-02-14. URL: https://docs.npmjs.com/about-npm.

[34] Yarnpkg. 1 - Introduction. Accessed: 2021-02-14. URL: https : / / yarnpkg . com/getting-started.

[35] Fetch. Accessed: 2021-03-05. April 2021.URL: https://fetch.spec.whatwg.

org/.

[36] Steve Hobbs. What is CORS? Complete Tutorial on Cross-Origin Resource Sha-ring. Accessed: 2021-03-05. April 2019. URL: https : / / auth0 . com / blog / cors-tutorial-a-guide-to-cross-origin-resource-sharing/.

In document Verktyg För Apidokumentation (Page 65-70)

Related documents