SampleAPIs icon indicating copy to clipboard operation
SampleAPIs copied to clipboard

Docs - How APIs Work

Open jermbo opened this issue 3 years ago • 5 comments

The purpose of Sample APIs is to be a resource to learn all things APIs.

I would like a documentation foundation set up explaining what an API is. This should include things like;

  • Acronym Definitions
  • HTTP Verb Explanations
    • Links to authority references
  • Simple Diagrams providing a visual explanation
  • ... anything you think a beginner would benefit from knowing

jermbo avatar Oct 05 '21 22:10 jermbo

Hello @jermbo I would like to contribute to this issue. Feel free to assign it to me on your free time 😄

ctnkaan avatar Oct 05 '21 22:10 ctnkaan

please assign it to me @jermbo

nishantdotcom avatar Oct 06 '21 05:10 nishantdotcom

Thank you for your interest!

We will not be assigning these to anyone specific at this time. Being this is a volunteer contribution, we don't want to obligate anyone to contribute should something arise. Nor do we want to exclude potential contributors. All ideas are welcome.

jermbo avatar Oct 06 '21 12:10 jermbo

Here's my latest contribution on the great Docs of this website:

https://github.com/jermbo/SampleAPIs/pull/159

thedamian avatar Oct 04 '22 23:10 thedamian

Should we add open API specs to the API's? I would be able to handle that if you like.

amritk avatar Mar 08 '24 01:03 amritk