Swagger框架学习分享

Swagger框架学习分享


一、背景介绍
1.1.项目简介
Swagger项目是由Dilip Krishnan和Adrian Kelly等人维护开发的一个为spring Web MVC 项目提供方法文档的一个框架。该框架最主要的功能是将Controller的方法进行可视化的展现，像方法注释，方法参数，方法返回值等都提供了相应的用户界面，尤其是对JSON参数的支持。同时可以结合swagger-ui可以对用户界面进行不同程度的定制，也可以对方法进行一个简单的测试。

1.2.code repository

• github:https://github.com/springdox/springdox
• maven：http://www.mvnrepository.com/artifact/com.mangofactory/swagger-springmvc

1.3.演示项目

• 官方：https://github.com/adrianbk/swagger-springmvc-demo
• 民间：https://github.com/qq291462491/bugkillers

二、开发准备
2.1.环境准备

• idea intellij 13+
• Oracle java 1.6
• Gradle 2.0 +

参考：http://blog.csdn.net/u010827436/article/details/44417637

Spring3 MVC中使用Swagger生成API文档
http://blog.csdn.net/jia20003/article/details/50700736


http://swagger.io/docs/

Swagger 使用文档
参考：http://www.2cto.com/kf/201604/499072.html