Home

Swaggen

Objective

Documentation has a tendency to get stale quite quickly because developers want to work on solving problems, not writing about them. The goal of this project is create a set of tools that will automatically create documentation for APIs. We want to offer a solution to ourselves and others as web developers to auto-generate the documentation based on a minimalist set of annotations that are to be integrated seamlessly in the developer workflow.

Project Functionality

This maven plugin provides an Annotation that allows REST API developers to document their endpoints by annotating their endpoint methods. A Swagger file will be generated from the annotations when the project builds. This file can be used, in combination with other external tools, to fully document the usage and purpose of any endpoint.

Architecture

This solution accomplishes it's functionality through a series of parsers and translators, that read data from the input space (annotations, JSON schemas, and config files) and maps that same information to the output space (a Swagger file). The different formats of data as well as the design of the parsers and translators are described in the project's architecture.

Usage

Detailed usage of the annotation can be read here: SwaggerGen Annotation Usage

Project Info

• Requirements
• Outline
• Team Info