接口规范swagger

本文档介绍了为何需要接口规范,以及如何使用Swagger来编写接口doc文档,实现包括引入jar包、配置SwaggerConfig和运行展示。通过Swagger,可以生成易于理解和测试的接口文档。
摘要由CSDN通过智能技术生成

1. 为什么需要

  • 接口测试人员要通过接口描述测试接口 --黑盒测试
  • 前端开发人员要通过接口描述使用接口.

2. 写接口doc文档

  • 直接整理出所有接口,每个接口有访问地址(访问方式),参数及返回值.
  • 可以直接通过后端代码产生能够让前台开发或测试人员能够看懂生成的swagger文档

3. 实现

  • 引入swagger需要的jar包
<!-- swagger引入包-->
	<properties>
        <!--swagger对应的版本-->
        <springfox.version>2.4.0</springfox.version>
    </properties>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>${
   springfox.version}</version
  • 1
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值