Swagger接口文档

本文档介绍了如何使用Swagger来实现RESTful API接口的文档化和在线测试。首先,通过添加依赖并配置Swagger,然后在Controller类及方法上添加注解,最后重启项目并访问特定URL进行接口测试。 Swagger提供了一个交互式的Web界面,方便开发者查看和测试API接口。
摘要由CSDN通过智能技术生成

目录

第一步添加依赖

第二步添加配置

①新建一个config包,写配置类

②加入api注解,在controller类上面 

​编辑

③每个方法上加入@ApiOperation注解,生成对应api

第三步在线测试接口

重启项目打开网页进入访问地址

出现此页面表示成功

 展开查看详情

输入要查询的名字测试

 结果


Swagger 是一个规范且完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务

第一步添加依赖

     <!--添加swagger的依赖-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>

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

第二步添加配置

①新建一个config包,写配置类

package com.qiu.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.doc
  • 2
    点赞
  • 12
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值