search

pydatadelhi / talks

Talks at PyData Delhi Meetups
44 stars 13 forks source link

Talk Proposal: Introduction to APIs. #81

Open mridubhatnagar opened 6 years ago

mridubhatnagar commented 6 years ago
manojpandey commented 6 years ago

@Dawny33 @shagunsodhani please review :)

shagunsodhani commented 6 years ago

Hey @mridubhatnagar Thank you for proposing a talk. Could you provide slides/notebook that you plan to use during the talk?

Dawny33 commented 6 years ago

@mridubhatnagar Would love to see the slides.

Having said that, most 'Intro to API' talks miss the 'testing' part. So, please have a slide on that too, where you explain people how to test out the APIs which they have built.

It can be by using the requests library, or some API testing tool like postman.

mridubhatnagar commented 6 years ago

Hey @mridubhatnagar Thank you for proposing a talk. Could you provide slides/notebook that you plan to use during the talk?

Hi @shagunsodhani Thanks for reviewing. Haven't prepared the slides yet. This shall be my first talk. Any specific things that I should include?

mridubhatnagar commented 6 years ago

@mridubhatnagar Would love to see the slides.

Having said that, most 'Intro to API' talks miss the 'testing' part. So, please have a slide on that too, where you explain people how to test out the APIs which they have built.

It can be by using the requests library, or some API testing tool like postman.

@Dawny33 Thanks for having a look. And suggesting about testing. That is going to be a definite plus I guess. Yes, I can talk about POSTMAN. As well as writing tests through Pytest to check the API.

Haven't prepared the slides though. Any key topics that I should take care of?

mridubhatnagar commented 6 years ago

Some topics I could think of include.

  1. Through various USE CASES examples explain API.
  2. API's at work
  3. How to create an API
  4. How to test an API
  5. Possible scenarios to be taken care of while creating an API
  6. Requests, Postman

The topic is vast and intent is to keep it short, crisp. So, that takeaway is worth it.

mridubhatnagar commented 5 years ago

Hey, @Dawny33 @shagunsodhani. Have updated the slides for the talk. Also, if I go onto explaining how to create an API. Before that I might have to give a basic idea about framework to the participants. Requests module I can still include.

Please let me know about the changes needed in the current one. Thanks

shagunsodhani commented 5 years ago

Hello @mridubhatnagar. Could you please share the updated slide link. It seems the one on the original issue is old as it does not mention moist od the things you mentioned in your previous comment. :)

mridubhatnagar commented 5 years ago

Hello @mridubhatnagar. Could you please share the updated slide link. It seems the one on the original issue is old as it does not mention moist od the things you mentioned in your previous comment. :)

@shagunsodhani Oh.. yes. I have updated the slides now. Also, as far as creating API is concerned. Should I explain it using Flask and Python? Or skip this part altogether?

As of now I don't have much points for point 5 as well. Possible scenarios to be taken care of while creating an API.

Any inputs will be helpful.

mridubhatnagar commented 5 years ago

Also should I explain HTTP/HTTPS as well?

shagunsodhani commented 5 years ago

Hi @mridubhatnagar

I think you should talk about Flask. For 5, maybe you can take the example of say GraphQL along with REST API. Also, much of your talk is about REST APIs so be careful that the audience does not leave with the impression that REST is the only kind of API. Skip the HTTP part.

mridubhatnagar commented 5 years ago

So, instead of covering SOAP API along with REST API. You mean I should cover GraphQL. And likewise in example also I should give one GraphQL example. Sure. I'll cover up creating API's using flask.

Need to check GraphQL. Haven't worked with it yet.

mridubhatnagar commented 5 years ago

@shagunsodhani @Dawny33 thanks for reviewing this and suggesting the changes. I did cover up the testing part, gave a brief introduction about GraphQL. Talked about fundamental building blocks Client, server, what is meant by protocol. APIs use cases. And other things as discussed.

However, covered up requests module. Still creating API with flask was something which could not be picked up. :)