初次尝试swagger springmvc集成 生成restful api文档
来源:互联网 发布:股票历史复权数据接口 编辑:程序博客网 时间:2024/05/17 07:37
1、maven 所需jar包
<dependency>
<groupId>com.mangofactory</groupId>
<artifactId>swagger-springmvc</artifactId>
<version>1.0.2</version>
</dependency>
<dependency>
<groupId>com.mangofactory</groupId>
<artifactId>swagger-models</artifactId>
<version>1.0.2</version>
</dependency>
<dependency>
<groupId>com.wordnik</groupId>
<artifactId>swagger-annotations</artifactId>
<version>1.3.11</version>
</dependency>
<!-- swagger-springmvc dependencies -->
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>15.0</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-annotations</artifactId>
<version>2.4.4</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.4.4</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-core</artifactId>
<version>2.4.4</version>
</dependency>
2、创建 SwaggerConfig配置文件
import com.mangofactory.swagger.configuration.SpringSwaggerConfig;
import com.mangofactory.swagger.models.dto.ApiInfo;
import com.mangofactory.swagger.plugin.EnableSwagger;
import com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
@EnableSwagger
//@EnableWebMvc
public class SwaggerConfig {
private SpringSwaggerConfig springSwaggerConfig;
/**
* Required to autowire SpringSwaggerConfig
*/
@Autowired
public void setSpringSwaggerConfig(SpringSwaggerConfig springSwaggerConfig)
{
this.springSwaggerConfig = springSwaggerConfig;
}
/**
* Every SwaggerSpringMvcPlugin bean is picked up by the swagger-mvc
* framework - allowing for multiple swagger groups i.e. same code base
* multiple swagger resource listings.
*/
@Bean
public SwaggerSpringMvcPlugin customImplementation()
{
return new SwaggerSpringMvcPlugin(this.springSwaggerConfig)
.apiInfo(apiInfo())
.includePatterns(".*?");
}
private ApiInfo apiInfo()
{
ApiInfo apiInfo = new ApiInfo(
"My Apps API Title",
"My Apps API Description",
"My Apps API terms of service",
"My Apps API Contact Email",
"My Apps API Licence Type",
"My Apps API License URL");
return apiInfo;
}
}
3、配置静态资源
<mvc:resources mapping="/dist/**" location="/WEB-INF/dist/"/>
4、在代码中添加相关APIAnnotation
@ResponseBody
@RequestMapping( value = "addUser", method = RequestMethod.POST, produces = "application/json; charset=utf-8")
@ApiOperation(value = "添加用户", httpMethod = "POST", response = BaseResultVo.class, notes = "add user")
public String addUser(@ApiParam(required = true, name = "postData", value = "用户信息json数据")@RequestParam( value = "postData") String postData,
HttpServletRequest request) {
LOGGER.debug(String.format("at function, %s", postData))if (null == postData || postData.isEmpty())
{returnsuper.buildFailedResultInfo(-1,"post data is empty!");}
UserInfo user = JSON.parseObject(postData, UserInfo.class);
int result = userService.addUser(user);
return buildSuccessResultInfo(result);
}
5、GitHub下载 Swagger UI
6、打开浏览器 输入 http://localhost/{project}/dist/index.html#
1、说是fastjsonapi问题,升级到1.2.15版本以上就可以解决了 参考:http://blog.csdn.net/nihaoqiulinhe/article/details/68490133
重新刷新浏览器:
大功告成!!!
- 初次尝试swagger springmvc集成 生成restful api文档
- springmvc集成Swagger自动生成api文档
- Swagger与SpringMvc集成生成Restful形式接口文档
- codeigniter集成Swagger自动化生成RESTFUL文档
- Swagger集成Springboot生成Restful api
- swagger 生成 PHP restful API 接口文档
- swagger 生成 PHP restful API 接口文档
- swagger生成RESTful API的doc文档
- Restful形式接口文档生成之Swagger与SpringMVC整合
- 使用swagger作为restful api的doc文档生成
- 使用swagger作为restful api的doc文档生成
- SpringBoot中使用Swagger生成RESTful规范API文档
- Swagger生成API文档
- springmvc集成swagger实现接口文档自动化生成
- springmvc集成swagger实现接口文档自动化生成
- Spring MVC 集成 Swagger,API文档自动生成~
- swagger ui和spring boot集成生成api文档
- swagger和springmvc结合自动生成api接口文档
- Qt分割窗口QSplitter类
- win7下创建mac虚拟机
- 习题5.2
- p(3.1-2)
- cookie与session
- 初次尝试swagger springmvc集成 生成restful api文档
- decode() missing 1 required positional arguement: 'output'
- WebViewJavascriptBridge源码解析 -1
- 2001年,在长沙牛耳软件培训中心的日子。
- IEEE 754 16进制编码转为64位双精度浮点数
- 一场公司内部奖金分配撕逼引发出来的段子
- Word2Vec模型总结
- Qt垂直/水平布局管理器(QBoxLayout,QHBoxLayout, QVBoxLayout)
- 最大公倍数最大公约数函数调用