Swagger+Spring MVC框架学习分享

最新推荐文章于 2024-11-07 11:56:53 发布

杜引强

最新推荐文章于 2024-11-07 11:56:53 发布

阅读量453

点赞数

分类专栏： java编程

java编程专栏收录该内容

27 篇文章

订阅专栏

本文介绍如何使用Swagger框架整合Spring项目，实现API接口文档自动生成。包括引入依赖、配置Swagger、编写控制器并展示最终效果。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

 
   [html] 
    view plain 
    copy
  
 最近参与公司接口编写，Android和IOS端都要调用这些接口，需要对接调试，如果没有一个接口文档，管理接口，别人用了接口，也不知道接口怎么用，接口上有什么参数，哪些是必须参数，哪些是非必须参数，于是研究了Swagger框架应用到项目中去，Swagger与Spring项目结合，Spring必须是4.0以上版本，下面是研究的小小demo:  

1、引入Swagger的jar包，由于我的是Maven项目，所以在pom.xml中（注意Spring是4.0以上版本）

 
   [html] 
    view plain 
    copy
  
 <dependency>  
            <groupId>io.springfox</groupId>  
            <artifactId>springfox-swagger2</artifactId>  
            <version>2.0.2</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、新增Swagger配置代码

 
   [java] 
    view plain 
    copy
  
 package cn.;  

 
   [java] 
    view plain 
    copy
  
 import org.springframework.context.annotation.Bean;  
 import org.springframework.context.annotation.Configuration;  
 import org.springframework.context.annotation.ComponentScan;  
 import org.springframework.web.servlet.config.annotation.EnableWebMvc;  
 import springfox.documentation.spi.DocumentationType;  
 import springfox.documentation.spring.web.plugins.Docket;  
 import springfox.documentation.swagger2.annotations.EnableSwagger2;  
   
 @Configuration  
 @EnableWebMvc  
 @EnableSwagger2  
 @ComponentScan(basePackages ={"com.test.api"})  
 /** 
  * 
  * @author xiaozhou  
  */  
 public class SwaggerConfig {  
   
    /** 
     * Every Docket 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 Docket customDocket(){  
       return new Docket(DocumentationType.SWAGGER_2);  
   
    }  
   
 }  

3、修改 applicationContext.xml

 
   [html] 
    view plain 
    copy
  
 <bean class="cn.conf.SwaggerConfig"/>  

4、增加一个测试的ContactController

 
   [java] 
    view plain 
    copy
  
 @Api(value = "contacts-api", description = "有关于用户的CURD操作", position = 5)  
 @Controller  
 @RequestMapping("/contacts")  
 public class ContactController {  
   @Autowired ContactService contactService;  
   @ResponseBody  
   @RequestMapping(value="/1.0/contact/get.do/{id}",method=RequestMethod.GET)  
   public Contact get(@PathVariable Long id) {  
     return contactService.find(id);  
   }  
   @ApiOperation(value = "创建用户", notes = "返回用户实体对象", response = Contact.class, position = 2)  
   @RequestMapping(value = "/1.0/contact/add.do", method=RequestMethod.POST)  
   public void add(@RequestBody Contact contact,HttpServletResponse response) {  
     contactService.create(contact);  
     String location = ServletUriComponentsBuilder.fromCurrentRequest()  
       .pathSegment("{id}").buildAndExpand(contact.getId())  
       .toUriString();  
    
     response.setHeader("Location",location);          
   }  
    
   @RequestMapping(value="/1.0/contact/update.do/{id}",method=RequestMethod.POST)  
   @ApiResponses(value = {  
             @ApiResponse(code = 200, message = "更新成功", response = Contact.class),  
             @ApiResponse(code = 404, message = "找不到页面"),  
             @ApiResponse(code = 500, message = "内部报错")}  
   )  
   public void update(@ApiParam(name="id", value="编号", required=true)@PathVariable Integer id,@RequestBody Contact contact) {  
     contact.setId(id);;  
     contactService.update(contact);  
   }  
 }  