Skip to content
ytsTony edited this page Nov 28, 2013 · 4 revisions

Welcome to swdogen wiki!

swdogen is a swagger documentation generator. It would scan and parse your project source code and generate the valid json file which can be feed to swagger-ui

Just 3 steps to use swdogen

Step 1. Configuration

Create a centre configuration file, _swdogen in the top-level directory of your project

Step 2. Documentation

Document your project files with swdogen notation.

For convinience, I have create some templates.

Step 3. Generation of swagger documentation

Just run

swdogen

from the top-level directory of your project