Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs - How APIs Work #141

Open
jermbo opened this issue Oct 5, 2021 · 5 comments
Open

Docs - How APIs Work #141

jermbo opened this issue Oct 5, 2021 · 5 comments

Comments

@jermbo
Copy link
Owner

jermbo commented Oct 5, 2021

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
Copy link
Contributor

ctnkaan commented Oct 5, 2021

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

@nishantdotcom
Copy link

please assign it to me @jermbo

@jermbo
Copy link
Owner Author

jermbo commented Oct 6, 2021

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
Copy link
Collaborator

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

#159

@amritk
Copy link

amritk commented Mar 8, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants