zoukankan      html  css  js  c++  java
  • SpringBoot整合Swagger

    添加依赖

    pom.xml

            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-bean-validators</artifactId>
                <version>2.8.0</version>
            </dependency>
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger2</artifactId>
                <version>2.8.0</version>
            </dependency>
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger-ui</artifactId>
                <version>2.8.0</version>
            </dependency>

    新建配置类

    SwaggerConfig.java

    package net.ybclass.online_ybclass.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.service.Contact;
    import springfox.documentation.spi.DocumentationType;
    import springfox.documentation.spring.web.plugins.Docket;
    import springfox.documentation.swagger2.annotations.EnableSwagger2;
    
    @Configuration
    @EnableSwagger2
    public class SwaggerConfig {
        @Bean
        public Docket customDocket() {
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .select()
                    .apis(RequestHandlerSelectors
                            .basePackage("net.ybclass.online_ybclass.controller"))
                    .paths(PathSelectors.any()).build();
        }
    
        private ApiInfo apiInfo() {
            Contact contact = new Contact("我的博客地址", "https://www.cnblogs.com/chenyanbin/", "543210188@qq.com");
            return new ApiInfoBuilder()
                    .title("API接口文档")
                    .description("接口描述")
                    .contact(contact)
                    .version("1.0.0").build();
        }
    }

    控制层注解

    import io.swagger.annotations.Api;
    import io.swagger.annotations.ApiOperation;
    import io.swagger.annotations.ApiParam;
    import org.springframework.web.bind.annotation.PostMapping;
    import org.springframework.web.bind.annotation.RequestParam;
    import org.springframework.web.bind.annotation.RestController;
    
    /**
     * @ClassName:SwaggerTest
     * @Description:TODO
     * @Author:chenyb
     * @Date:2020/9/22 6:03 下午
     * @Versiion:1.0
     */
    @RestController
    @Api(description = "swagger基础数据接口",tags = "SwaggerTest")
    public class SwaggerTest {
        @PostMapping("test")
        @ApiOperation("测试类")
        public String test(@ApiParam(name = "name", value = "姓名", required = true)@RequestParam("name") String name){
            System.out.println("name="+name);
            return "ok";
        }
    }

    测试

  • 相关阅读:
    SQL语句基础之 单表查找
    SQL语句基础之 管理数据库,表 和 数据
    JavaWeb之 JSP:自定义标签
    JavaWeb之 JSP:内置对象,EL表达式,JSP标签基础
    JavaWeb之 JSP基础
    JavaWeb之Servlet:Cookie 和 Session
    JavaWeb之Servlet: ServletConfig 与 ServletContext
    JavaWeb之 Servlet执行过程 与 生命周期
    JavaWeb之Servlet:请求 与 响应
    Vue.js中 watch(深度监听)的最易懂的解释
  • 原文地址:https://www.cnblogs.com/chenyanbin/p/13713960.html
Copyright © 2011-2022 走看看