How does SM document their APIs?
Question asked by Connie DeCinko - December 6, 2016 at 9:46 AM
Answered
We really like how SM documents their APIs.  How do they do that?  Are they using an automated tool?  Writing the pages by hand?

5 Replies

Reply to Thread
0
Larry Duran Replied
Employee Post Marked As Answer
Hello Connie.
 
We sort of have our own tool that looks for our API code and then builds out the documentation based on different attributes tied to our API.  Once we have all the information we need we just put it all together with some HTML and CSS styling.  Nothing too crazy but it is all in house code that generates our documentation.
Larry Duran
Software Developer
SmarterTools Inc.
(877) 357-6278
www.smartertools.com
0
Larry, thanks for the feedback. Any chance you'd be willing to share the code?
0
Larry Duran Replied
Employee Post
I sent you an email with some details. If you need more of an explanation just let me know.
Larry Duran
Software Developer
SmarterTools Inc.
(877) 357-6278
www.smartertools.com
0
Larry, we had issues with our email server this morning. Can you please resend? Thanks.
0
Larry Duran Replied
Employee Post
I re-sent it to you.
Larry Duran
Software Developer
SmarterTools Inc.
(877) 357-6278
www.smartertools.com

Reply to Thread