接口管理swagger2、APIFox简单学习总结

文章介绍了如何在项目中集成Swagger2来生成API文档,包括添加Springfox依赖,配置SwaggerConfig类,设置Docketbean,以及通过http://localhost:8080/swagger-ui.html访问接口文档。此外,还提到了使用APIFox工具作为更便捷的接口管理方式。
摘要由CSDN通过智能技术生成

使用swagger2需要在项目中配置SwaggerConfig类,以及导入相关的依赖

<!--swagger2的依赖包-->
        <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>

接下来配置SwaggerConfig类

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket webApiConfig(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("dev")
                .apiInfo(webApiInfo())
                .select()
                .paths(Predicates.not(PathSelectors.regex("/error.*")))
                .build();
    }

    private ApiInfo webApiInfo(){
        return new ApiInfoBuilder()
                .title("Swagger2简单测试")
                .description("项目名字" +
                        "接口定义")
                .version("1.0")
                .contact(new Contact("名字", "http://localhost:8080/swagger-ui.html", ""))
                .build();
    }

}

启动项目,在网页打开http://localhost:8080/swagger-ui.html 

端口号等凭专辑项目需要修改即可,如下图

接口各种信息就在该网页中出现

也可使用第三方软件,即APIFox

 创建团队

 导入项目或者新建项目

 在此页面中新建接口即可,这个软件更加方便,功能齐全。

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值