Swagger+Spring MVC框架學習分享

時間 2019-11-19

標籤 swagger+spring swagger spring mvc 框架學習分享欄目 Spring 简体版

原文原文鏈接

 
   [html] 
    view plain 
    copy 
  
 最近參與公司接口編寫，Android和IOS端都要調用這些接口，須要對接調試，若是沒有一個接口文檔，管理接口，別人用了接口，也不知道接口怎麼用，接口上有什麼參數，哪些是必須參數，哪些是非必須參數，因而研究了Swagger框架應用到項目中去，Swagger與Spring項目結合，Spring必須是4.0以上版本，下面是研究的小小demo:  

一、引入Swagger的jar包，因爲個人是Maven項目，因此在pom.xml中（注意Spring是4.0以上版本）html

 
   [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>    

二、新增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);  
   
    }  
   
 }  

三、修改 applicationContext.xml

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

四、增長一個測試的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);  
   }  
 }  