引入swagger(2)——与spring-boot整合

来源:互联网 发布:java开发电脑配置要求 编辑:程序博客网 时间:2024/06/05 14:52

      第一篇文章介绍了与传统的spring整合,这里介绍如何与spring-boot整合。我们可以发现spring-boot简化了相当多的配置

      第一篇文章链接《引入swagger(1)——与传统spring整合》

      pom

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


       java config

import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import springfox.documentation.builders.ApiInfoBuilder;import springfox.documentation.builders.PathSelectors;import springfox.documentation.builders.RequestHandlerSelectors;import springfox.documentation.service.ApiInfo;import springfox.documentation.spi.DocumentationType;import springfox.documentation.spring.web.plugins.Docket;import springfox.documentation.swagger2.annotations.EnableSwagger2;@Configuration@EnableSwagger2public class SwaggerConfig {@Bean    public Docket createRestApi() {        return new Docket(DocumentationType.SWAGGER_2)                .apiInfo(apiInfo())                .select()                .apis(RequestHandlerSelectors.basePackage("com.wlf.demo"))                .paths(PathSelectors.any())                .build();    }    private ApiInfo apiInfo() {        return new ApiInfoBuilder()                .title("RESTful APIs")                .description("实例")                .termsOfServiceUrl("http://www.baidu.com/")                .contact("wlf")                .version("1.0")                .build();    }}


这样就可以了,访问地址http://服务器/swagger-ui.html就可以了

        举个例子

@ApiOperation(value="新建用户", notes="新建用户")@ApiImplicitParams({        @ApiImplicitParam(name = "token", value = "令牌", required = true, dataType = "String", paramType="header")})@RequestMapping(value="/{userid}", method=RequestMethod.PUT)public String putUser(@ApiParam(name="userid", value="用户id")   @PathVariable String userid,   @ApiParam(name="user")   @ModelAttribute User user) { User u = users.get(userid);         u.setUsername(user.getUsername());         u.setPassword(user.getPassword());         users.put(userid, u);         return "success"; }



原创粉丝点击