swagger項目集成步驟

1、背景

       目前大部分微服務都採用前後端分離的形式進行開發。這樣做的好處在於工作細分，但是對開發後端的開發人員來說，和前端對接的時候，接口文檔的撰寫可謂是件非常頭疼的事情了。Sping當然也考慮到這件事，所以swagger就出來了。下面可以看整合swagger是具體步驟。

2、步驟

第一點、jar包導入。這當然是必不可少的。

   <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.9.2</version>
   </dependency>
   <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.9.2</version>
   </dependency>

第二步、寫swagger配置類

@Configuration
@EnableSwagger2
public class SwaggerConfig {


  @Bean
  public Docket allApi() {
    return new Docket(DocumentationType.SWAGGER_2)
        .enable(true)
        .select()
        .apis(RequestHandlerSelectors.basePackage("com.demo"))
        .build();
  }
}

這裏也就相當於指定一下掃描什麼包下面。

第三步、在controller類裏面寫上swagger的相應註解描述即可，比如：

    @ApiOperation(value="這是一個API接口",notes="描述一下接口內容")

當然swagger還有很多其他的註解，可以去官方網址查詢對應的寫法、。https://swagger.io/

如果按照上面步驟集成完畢了，可以在地址欄輸入地址：

http://ip地址：項目端口/項目名/swagger-ui.html  

就可以訪問了，如圖出現這樣的：

說明就正確了。

3、總結

        其實目前來說，java生態圈非常的完善了，許多比較複雜的東西，都可以在開源社區找到相應的解決方案。不過我對swagger做了一些自己的初步判斷，如果項目中要求性能比較高的項目，我覺得還是老老實實寫文檔吧，因爲swagger需要使用到大量的註解，而註解其實是通過反射的形式實現的，相當於一種糖語法而已。所以對性能還是會造成一定的影響。