SSM框架基於swagger2實現API管理

SSM框架基於swagger2實現API管理

swagger官網：
swagger.io/docs/

1.添加maven依賴

<!--swagger-->
<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger2</artifactId>
  <version>${swaggger.version}</version>
</dependency>
<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger-ui</artifactId>
  <version>${swaggger.version}</version>
</dependency>複製代碼

2.下載swagger

swagger.io/download-sw…

3.配置SwaggerConfig

/**
 * @Author： CatalpaFlat
 * @Descrition:
 * @Date: Create in 11:26 2017/11/14
 * @Modified BY：
 */
@EnableWebMvc
@EnableSwagger2
@Configuration
@ComponentScan(basePackages ="com.chen")
public class SwaggerConfig extends WebMvcConfigurationSupport {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.chen"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("SSM-Swagger2 APIs")
                .termsOfServiceUrl("http://blog.csdn.net/dushiwodecuo")
                .contact(new Contact("CatalpaFlat","http://blog.csdn.net/dushiwodecuo","1013427541@qq.com"))
                .version("1.0.0")
                .build();
    }

}複製代碼

4.修改swagger2附帶的index.html

修改index.html中的 petstore.swagger.wordnik.com/v2/swagger.…,
例如：http://localhost:8080/api/api-docs

---

5.註解使用

@RequestMapping
@RestController
@Api(description="測試接口")
public class TestController {
    @Resource
    private TestService testService;

    @GetMapping(value = "get")
    @ApiOperation(value = "獲取值",httpMethod = HttpMethod.GET,response = List.class,notes ="get name")
    public List<Test> get(){
        return testService.get();
    }

    @ApiOperation(value = "設置值",httpMethod = HttpMethod.GET,response = String.class,notes ="set name")
    @ApiImplicitParam(value = "name",dataType = "form",required = true,defaultValue = "21378127")
    @GetMapping(value = "set/{name}",consumes = MediaType.APPLICATION_FORM_URLENCODED_VALUE)
    public String set(@PathVariable String name){
        return testService.set(name);
    }
}複製代碼

5.啓動測試

瀏覽器地址欄輸入：http://localhost:8080/api/index.html

6.swagger2經常使用註解以下

• @Api()用於類；
  表示標識這個類是swagger的資源
• @ApiOperation()用於方法；
  表示一個http請求的操做
• @ApiParam()用於方法，參數，字段說明；
  表示對參數的添加元數據（說明或是否必填等）
• @ApiModel()用於類
  表示對類進行說明，用於參數用實體類接收
• @ApiModelProperty()用於方法，字段
  表示對model屬性的說明或者數據操做更改
• @ApiIgnore()用於類，方法，方法參數
  表示這個方法或者類被忽略
• @ApiImplicitParam() 用於方法
  表示單獨的請求參數
• @ApiImplicitParams() 用於方法，包含多個 @ApiImplicitParam