Docs - How APIs Work - Githubissues

jermbo / SampleAPIs

A simple, no fuss, no mess, no auth playground for learning RESTful or GraphQL APIs.

https://sampleapis.com/

MIT License

214 stars 50 forks source link

Docs - How APIs Work #141

Open jermbo opened 2 years ago

jermbo commented 2 years ago

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

ctnkaan commented 2 years ago

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

nishantdotcom commented 2 years ago

please assign it to me @jermbo

jermbo commented 2 years ago

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.

thedamian commented 1 year ago

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

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

amritk commented 6 months ago

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