当前位置:   article > 正文

swagger配置(SSM) maven_swagger-annotations maven 依赖

swagger-annotations maven 依赖

附上swagger注解解析
普通SSM项目搭建
​​​​​​​导入jar包
添加到 dependencies标签内

  1. <dependency>
  2. <groupId>io.springfox</groupId>
  3. <artifactId>springfox-swagger2</artifactId>
  4. <version>2.8.0</version>
  5. </dependency>
  6. <!--springfox-ui的jar包(里面包含了swagger的界面静态文件)-->
  7. <dependency>
  8. <groupId>io.springfox</groupId>
  9. <artifactId>springfox-swagger-ui</artifactId>
  10. <version>2.7.0</version>
  11. </dependency>
  12. <!--springfox依赖的jar包;如果你的项目中已经集成了无需重复-->
  13. <dependency>
  14. <groupId>com.fasterxml.jackson.core</groupId>
  15. <artifactId>jackson-databind</artifactId>
  16. <version>2.9.0</version>
  17. </dependency>

创建swaggerConfig.java文件
ps:我是直接扔到controller文件夹内的,也可以单独一个文件夹存放

  1. package com.bdqn.controller;
  2. import org.springframework.context.annotation.Bean;
  3. import org.springframework.context.annotation.ComponentScan;
  4. import org.springframework.test.context.web.WebAppConfiguration;
  5. import org.springframework.web.servlet.config.annotation.EnableWebMvc;
  6. import springfox.documentation.builders.ApiInfoBuilder;
  7. import springfox.documentation.builders.RequestHandlerSelectors;
  8. import springfox.documentation.service.ApiInfo;
  9. import springfox.documentation.spi.DocumentationType;
  10. import springfox.documentation.spring.web.plugins.Docket;
  11. import springfox.documentation.swagger2.annotations.EnableSwagger2;
  12. /*重要!如果你的项目引入junit测试(jar),此处需要使用@WebAppConfiguration,
  13. 如果没有使用junit使用@Configuration(友情转载~博客:jinqianwang)*/
  14. @EnableSwagger2
  15. @WebAppConfiguration
  16. @EnableWebMvc
  17. /*扫描controller层,监听~*/
  18. @ComponentScan("com.bdqn.controller")
  19. public class SwaggerConfig {
  20. @Bean
  21. public Docket api() {
  22. return new Docket(DocumentationType.SWAGGER_2)
  23. .select()
  24. .apis(RequestHandlerSelectors.any())
  25. .build()
  26. .apiInfo(apiInfo());
  27. }
  28. private ApiInfo apiInfo() {
  29. return new ApiInfoBuilder()
  30. .title("XXX项目接口文档")
  31. .description("XXX项目接口测试")
  32. .version("1.0.0")
  33. .termsOfServiceUrl("")
  34. .license("")
  35. .licenseUrl("")
  36. .build();
  37. }
  38. }

追加内容到spring-mvc.xml

  1. </mvc:annotation-driven>
  2. <!--将静态资源交由默认的servlet处理-->
  3. <mvc:default-servlet-handler />
  4. <!--向容器自动注入配置-->
  5. <context:annotation-config />
  6. <!--重要!将你的SwaggerConfig配置类注入-->
  7. <bean class="com.bdqn.controller.SwaggerConfig"/>
  8. <!--重要!配置swagger资源不被拦截-->
  9. <!-- <mvc:resources mapping="swagger-ui.html" location="classpath:/META-INF/resources/" />
  10. <mvc:resources mapping="/webjars/**" location="classpath:/META-INF/resources/webjars/" />-->

controller层

  1. package com.bdqn.controller;
  2. import com.alibaba.fastjson.JSONArray;
  3. import com.bdqn.service.GoodsService;
  4. import io.swagger.annotations.Api;
  5. import io.swagger.annotations.ApiOperation;
  6. import org.springframework.web.bind.annotation.RequestMapping;
  7. import org.springframework.web.bind.annotation.RequestMethod;
  8. import org.springframework.web.bind.annotation.RestController;
  9. import javax.annotation.Resource;
  10. /*tags是进去swgger-ui网页显示的controller名字,description是这个controller的描述*/
  11. @Api(tags = "这是商品的API",description = "这是商品类的controller")
  12. @RestController
  13. public class GoodsController {
  14. @Resource
  15. private GoodsService goodsService;
  16. public GoodsService getGoodsService() {
  17. return goodsService;
  18. }
  19. public void setGoodsService(GoodsService goodsService) {
  20. this.goodsService = goodsService;
  21. }
  22. /*顺序不能反,必须先requestmapping*/
  23. @RequestMapping(value = "/goods",method = RequestMethod.GET)
  24. /*value是该请求的说明,httpMethod显示提交方式,notes是详细说明*/
  25. @ApiOperation(value = "直接获取所有商品信息",httpMethod="get",notes="获取商品信息")
  26. public String getDate(){
  27. return JSONArray.toJSONString(goodsService.findAll());
  28. }
  29. }

demo结构图

 

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/花生_TL007/article/detail/373164
推荐阅读
相关标签
  

闽ICP备14008679号