Re: Documentation for REST APIs

[Caroline Tabach <caroline -dot- tabach -at- gmail -dot- com>]

Apologize for some spelling mistakes previously

> Hi,
> I am preparing documentation for the above.
> From research I can see that there are tools such as Swagger to
> automatically generate.
> 1. Is this how you make the documentation?
> 2. How do you edit the information the developers put in? In the source?
> 3. Do you then export the files or use as is?
>
> Or do you create a regular document with explanations?
>
> Thanks
>
> Caroline
> Caroline -dot- tabach -at- gmail -dot- com
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot- 

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot-  Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications?  Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions?  Search our public email archives @ http://techwr-l.com/archives