Uploaded byAnindita Basu
API documentation
The document discusses creating and documenting an API. It outlines the workshop goals of creating an API, documenting it, and creating reference documents and how-to guides. It then provides steps to create an API account on sheetlabs.com, import a spreadsheet to create an API from the data, and document the API by describing what it contains and how results can be filtered. It also includes links to example API documentation and discusses creating conceptual documents, documenting the API using Swagger, and writing how-to documentation through examples, code libraries, and SDKs.
More Related Content
API documentation
- 1.
- 2. anindita_basu Workshop goals • Createyour API • Document it • Reference documents • Concept documents • HowTos
- 3.
- 4.
- 5.
- 6.
- 7. anindita_basu Create an API 1.Create an account at sheetlabs.com.
- 8. anindita_basu Create an API 1.Create an account at sheetlabs.com. Give a name to your account. Give a 3-letter code for your account. All fields are mandatory.
- 9. anindita_basu Create an API 1.Create an account at sheetlabs.com. 2. Click Data tables > Import Data Table and import your spreadsheet. Accept the default selections.
- 10. anindita_basu Create an API 1.Create an account at sheetlabs.com. 2. Click Data tables > Import Data Table and import your spreadsheet. Accept the default selections.
- 11. anindita_basu Create an API 1.Create an account at sheetlabs.com. 2. Click Data tables > Import Data Table and import your spreadsheet. Accept the default selections. 3. Click Create an API from this Data Table. Accept the defaults.
- 12. anindita_basu Create an API 1.Create an account at sheetlabs.com. 2. Click Data tables > Import Data Table and import your spreadsheet. Accept the default selections. 3. Click Create an API from this Data Table. Accept the defaults. Required field Required field Change the permission to Public. Leave this as-is. Leave this as-is.
- 13. anindita_basu Go to theAPI you just created
- 14. anindita_basu 1 2 Go to theAPI you just created
- 15.
- 16.
- 17.
- 18. anindita_basu Document your API Whatdoes your API do/contain? Can the results returned by your API be filtered? If so, describe how to use the fields to filter results.Describe what these fields mean in the results returned by your API.
- 19.
- 20. anindita_basu Checkpoint • Create yourAPI • Document it • Reference documents • Concept documents • HowTos
- 21.
- 22. anindita_basu About your API •Authentication • Rate limits • License • Error codes • Versions and release notes • Additional resources
- 23.
- 24. anindita_basu https://developer.oxforddictionaries.com/documentation/glo ssary https://developer.twitter.com/en/docs/basics/authentication /overview/oauth Use your favouriteword processor to write a conceptual document for your API.
- 25. anindita_basu Checkpoint • Create yourAPI • Document it • Reference documents • Concept documents • HowTos
- 26.
- 27.
- 28.
- 29.
- 30. anindita_basu Import the YAMLfile I emailed you
- 31. anindita_basu Document your APIin Swagger Give a title to your API
- 32.
- 33. anindita_basu HTTP methods • GET •POST • DELETE
- 34. anindita_basu Make a GETrequest to your API
- 35. anindita_basu Document your APIin Swagger
- 36.
- 37.
- 38.
- 39.
- 40.
- 41. anindita_basu Checkpoint • Create yourAPI • Document it • Reference documents • Concept documents • HowTos
- 42. anindita_basu Task documentation • Examples •Code libraries • SDKs
- 43.
- 44.
- 45. anindita_basu Create an algorithm Input:2 numbers Output: The number that’s greater
- 46. anindita_basu Create an algorithm get2 numbers X and Y if X < Y, Print "Y is greater than X" else, Print "X is greater than Y"
- 47. anindita_basu Create an algorithm •Data source: Your API • Goal: Find the youngest person in the database.
- 48. anindita_basu Create an algorithm 1.Make a GET request to the API. 2. From the results, extract the following two fields, and put them into a list: • name • bornwhen 3. Sort the list in ascending order. 4. Print the value of name of the first entry in the list.
- 49.
- 50. anindita_basu Play with APIs •Game of Thrones: https://anapioficeandfire.com/ • Star Wars: https://swapi.co/ • Harry Potter: https://www.potterapi.com/ • Oxford Dictionaries: https://developer.oxforddictionaries.com/documentation • Vedas: https://aninditabasu.github.io/rigVeda/
- 51.