zoukankan      html  css  js  c++  java
  • springmvc 与 springfox-swagger2整合

    一、pom.xml引入基于maven的swagger依赖

         <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>
    
            <dependency>
                <groupId>com.fasterxml.jackson.core</groupId>
                <artifactId>jackson-databind</artifactId>
                <version>2.9.7</version>
            </dependency>

    二、编写SwaggerConfig配置类

    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.ComponentScan;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.web.servlet.config.annotation.EnableWebMvc;
    import springfox.documentation.builders.ApiInfoBuilder;
    import springfox.documentation.builders.PathSelectors;
    import springfox.documentation.builders.RequestHandlerSelectors;
    import springfox.documentation.service.ApiInfo;
    import springfox.documentation.service.Contact;
    import springfox.documentation.spi.DocumentationType;
    import springfox.documentation.spring.web.plugins.Docket;
    import springfox.documentation.swagger2.annotations.EnableSwagger2;
     
    @Configuration
    @EnableSwagger2
    @EnableWebMvc
    @ComponentScan(basePackages = {"com.foriseland.fsoa.pay.controller"})
    public class SwaggerConfig {
         @Bean
            public Docket customDocket() {
                return new Docket(DocumentationType.SWAGGER_2)
                        .apiInfo(apiInfo())      
                        .select()
                        .apis(RequestHandlerSelectors.any())
                        .paths(PathSelectors.any())
                        .build();
            }
     
            private ApiInfo apiInfo() {
                Contact contact = new Contact("支付组", "", "");
                return new ApiInfoBuilder()
                        .title("支付API接口")
                        .description("支付API接口")
                        .contact(contact)
                        .version("1.1.0")
                        .build();
            }
    }

    三、在spring mvc配置xml里面加入Swagger配置

      <!-- swagger -->
       <bean class="com.foriseland.fsoa.pay.swagger.SwaggerConfig"></bean>
       <mvc:default-servlet-handler/>
       <mvc:resources mapping="swagger-ui.html" location="classpath:/META-INF/resources/"/>
       <mvc:resources mapping="/webjars/**" location="classpath:/META-INF/resources/webjars/"/>

    四、controller层的编写例子

    @Controller
    @CrossOrigin
    @Api(tags="账户信息控制类")
    @RequestMapping("account")
    public class AccountController{
    
        @ApiOperation(value = "获取盈豆数量", notes = "获取盈豆数量", httpMethod = "POST")
        @RequestMapping(value="getBeansNumber", method=RequestMethod.POST)
        @ResponseBody
        public void getBeansNumber(@RequestBody BeansCountDto info, HttpServletResponse response) {
     
        }
    }

    五、启动项目

    http://127.0.0.1:8080/{projectName}/swagger-ui.html

    参考:https://blog.csdn.net/lovelichao12/article/details/79387569

  • 相关阅读:
    状态管理cookie 案例
    JavaScript对象(document对象 图片轮播)
    JavaScript对象(窗口对象 定时器对象 )
    JavaScript对象(正则表达式,Date对象,function对象 arguments对象)
    CSS概述<选择器总结>
    HTML表单
    Web表格
    JDBC项目实践
    JDBC获取表的主键
    JDBC中DAO事务函数模版
  • 原文地址:https://www.cnblogs.com/vvonline/p/10020596.html
Copyright © 2011-2022 走看看