Documentation for REST APIs

Subject: Documentation for REST APIs
From: Caroline Tabach <caroline -dot- tabach -at- gmail -dot- com>
To: techshoret -at- yahoogroups -dot- com, techwr-l mailinglist <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 19 Sep 2016 15:16:29 +0300

I am preparing documentation for thw 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?


Caroline -dot- tabach -at- gmail -dot- com
Visit TechWhirl for the latest on content technology, content strategy and content development |


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 for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at

Looking for the archived Techwr-l email discussions? Search our public email archives @


Previous by Author: RE: Support Tickets
Next by Author: Re: Documentation for REST APIs
Previous by Thread: Re: Phrasal adjective hyphenation
Next by Thread: Re: Documentation for REST APIs

What this post helpful? Share it with friends and colleagues:

Sponsored Ads