1. API DOCUMENTATION Swetha Mohandas Microsoft Connect 2016
1/17/2019 5:40 PM
API DOCUMENTATION
Swetha Mohandas
© 2016 Microsoft Corporation. All rights reserved. MICROSOFT MAKES NO WARRANTIES, EXPRESS, IMPLIED OR STATUTORY, AS TO THE INFORMATION IN THIS PRESENTATION.

2. Agenda What is API Documentation? Types API’s
Microsoft Connect 2016
1/17/2019 5:40 PM
Agenda
What is API Documentation?
Types API’s
How to Write API Documentation?
Swagger
GET and POST
Demo
© 2016 Microsoft Corporation. All rights reserved. MICROSOFT MAKES NO WARRANTIES, EXPRESS, IMPLIED OR STATUTORY, AS TO THE INFORMATION IN THIS PRESENTATION.

3. What is API Documentation?
1/17/2019 5:40 PM
What is API Documentation?
API stands for Application Programming Interface
API documentation is a deliverable of a technical writer which describes, with examples, how to effectively use a Software, Hardware or Web API. It requires a thorough understanding of the API, its arguments, its return type and the languages and interface it supports
It is important to make sure that the client, or consumer, is able to quickly implement your API and understand what is happening.
© 2016 Microsoft Corporation. All rights reserved. MICROSOFT MAKES NO WARRANTIES, EXPRESS, IMPLIED OR STATUTORY, AS TO THE INFORMATION IN THIS PRESENTATION.

4. Types API’s
Software API-Are APIs that provide access to the functions or services provided by another software.
SCPI (Hardware API)-
Web API-Are APIs that provide access to the functions or services provided by a web-service or website.

5. How to write API Documentation?
URL
Methods(GET/POST/PUT/DELETE)
URL Parameters
-Required
-Optional
Success Response
Error Response

6. Swagger API documentation tool
Allows you to describe the structure of the API
Use Swagger UI to generate interactive API documentation that lets your users try out the API calls directly in the browser.

7. Basic Structure of swagger

8. GET/POST Methods HTTP Request Method
Requests data from a specified resource
Submits data to be processed to a specified resource

9. DEMO Microsoft Connect 2016 1/17/2019 5:40 PM
© 2016 Microsoft Corporation. All rights reserved. MICROSOFT MAKES NO WARRANTIES, EXPRESS, IMPLIED OR STATUTORY, AS TO THE INFORMATION IN THIS PRESENTATION.

10. Thank You