Just to add to what others have mentioned, I did a search for "API
documentation" on Udemy.com and there is a nice list of API courses:
https://www.udemy.com/courses/search/?q=api%20documentation
I think there are two different types of APIs:
1. A list if software functions
2. Web-based
Are www.writethedocs.org and writethedocs.slack.com the same?
On 22-Nov-17 10:26 PM, Rick Quatro wrote:
Hi Craig,
You might want to check out:
http://www.writethedocs.org/
Rick Quatro
Carmen Publishing Inc.
r...@frameexpert.com
585-366-4017
-Original Message-
From: Framers
Write the Docs has a Slack channel and a forum under their umbrella (along with
an annual conference and meetups all over the world).
-Original Message-
From: Framers
[mailto:framers-bounces+jeff.coatsworth=jonasclub@lists.frameusers.com] On
Behalf Of Shmuel Wolfson
Sent: Thursday,
Hi Allison.
I've done a fair bit of API documentation, so feel free to ask me
questions.
The thing to remember is that basically an API doc is a cookbook. You
are providing the recipe and cooking instructions.
Most APIs these days are in some variant of XML (XML, YAML, YANG, etc.),
so
The kinds of API docs I would distinguish are:
1. generated from source code using native tools (e.g. javadoc and pydoc)
2. generated from source code using native code comments and a
third-party tool (e.g. Python docstrigs + Sphinx)
3. generated from source code using third-party tools (e.g. C++
Hi Shmuel
You are correct. The second form are usually called REST or RESTful
applications.
The main difference from our perspective is that for the REST type, you
really do need to provide a lot more "recipes" for how the various HTTP
requests (GET, POST, PATCH, DELETE, HEAD, OPTIONS, etc.)
