当前位置: 首页 > 工具软件 > TSF > 使用案例 >

腾讯tsf使用swagger

鞠子轩
2023-12-01

pom.xml文件新加

     <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
            <exclusions>
                <exclusion>
                    <groupId>com.google.guava</groupId>
                    <artifactId>guava</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>joda-time</groupId>
                    <artifactId>joda-time</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
            <version>20.0</version>
        </dependency>
        <dependency>
            <groupId>joda-time</groupId>
            <artifactId>joda-time</artifactId>
            <version>2.10</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <optional>true</optional>
        </dependency>

标题


@Configuration
@EnableSwagger2
public class SwaggerConfiguration {
	@Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("项目名称")
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("文件扫描路径"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("audiwxmall中使用Swagger2构建RESTful APIs")
                .description("接口简单描述")
                .termsOfServiceUrl("服务地址")
                .version("1.0")
                .build();
    }
}

访问地址 服务器ip:端口/swagger-ui.html

备注:也可以使用knife4j代替swagger,但是配置还是要配置SwaggerConfiguration

        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-micro-spring-boot-starter</artifactId>
            <version>2.0.0</version>
        </dependency>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-ui</artifactId>
            <version>2.0.0</version>
        </dependency>

knife4j地址 服务器ip:端口/doc.html

 类似资料: