STC Summit 2017 has ended
Tuesday, May 9 • 1:00pm - 1:50pm
Generating Web Service API Documentation Automatically from the Source Code

Sign up or log in to save this to your schedule, view media, leave feedback and see who's attending!

Learn a new way of generating real-time interactive documentation for web service APIs that enables API users to try APIs without having to create a “sandbox,” which often is time-consuming and complicated. You’ll see demonstrations of two popular, powerful tools that perform these tasks: RESTful API Modeling Language (RAML) and Swagger (now called OpenAPI Specification). You’ll also learn how these tools are used to document APIs, receive instructions on setting up and configuring both RAML and Swagger, and learn the strengths and weaknesses of both approaches.

avatar for Ed Marshall

Ed Marshall

Marshall Documentation Consulting
Ed is an independent consultant technical writer and the sole proprietor of Marshall Documentation Consulting, with over 28 years in technical writing. He specializes in technical documentation for developers including APIs (application programming interfaces), SDKs (software developer’s... Read More →

Tuesday May 9, 2017 1:00pm - 1:50pm EDT
Annapolis 1/2