推荐一款API神器Swagger 推荐一款几百元调音台比较好
yuyutoo 2024-10-12 01:49 5 浏览 0 评论
现在的网站架构基本上都是前后端分离，然后出现了前端工程师和后端工程师的岗位区分(当然你也可以是全栈的)。前端和后端的唯一联系，变成了API接口；API文档变成了前后端开发人员联系的纽带，变得越来越重要
相信大多数朋友都遇到过上面的场景：明明调用的是之前约定好的API，拿到的结果却不是想要的。可能因为是有人修改了API的接口，却忘了更新文档；又或者是文档写的有歧义，大家的理解各不相同。
一般软件开发项目组都会有API文档，它是前后端开发人员配合工作的桥梁。常规文档的形式都是记录在word或者是类似confluence的wiki服务器上。
但是这些形式都会出现上面的问题。让API文档总是与API定义同步更新，是一件非常有价值的事。
于是今天我来介绍一款API神器（Swagger）。Swagger号称是最好的API工具。官方网站 https://swagger.io/
Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful风格的Web服务。
Swagger作用：
1. 在线自动生成排版优美的接口文档。
2. 功能测试。
鉴于swagger的强大功能，Java开源界大牛spring框架迅速跟上，它充分利用自已的优势，把swagger集成到自己的项目里，整了一个spring-swagger，
后来便演变成springfox。springfox本身只是利用自身的aop的特点，通过plug的方式把swagger集成了进来，它本身对业务api的生成，还是依靠swagger来实现。
maven依赖：
=>@EnableSwagger2注解,启动Swagger支持，表示这是一个Spring Swagger的配置文件
=>@Api表示这是一个需要Swagger表示的类写在Controller的头部
@ApiOperaction表示这是一个需要Swagger修饰的接口，其中表明了接口名称，请求方式、备注说明等信息。
@ApiImplicitParam表示该接口输入的参数：
name表示参数名称；
value表示参数说明；
paramType表示传入类型，请求头传入写query,JSON类型传入写json；
defaultValue表示默认值；
required表示参数是否必须传。
项目启动后就可以直接用类似于以下的地址来查看api列表了：
http://127.0.0.1:8080/jadDemo/swagger-ui.html
是不是很不错，try it！
相关推荐
- 自卑的人容易患抑郁症吗?（自卑会导致抑郁吗）
-
Filephoto[Photo/IC]Lowself-esteemmakesusfeelbadaboutourselves.Butdidyouknowthatovert...
- 中考典型同(近)义词组（同义词考题）
-
中考典型同（近）义词组...
- BroadcastReceiver的原理和使用（broadcast-suppression）
-
一、使用中注意的几点1.动态注册、静态注册的优先级在AndroidManifest.xml中静态注册的receiver比在代码中用registerReceiver动态注册的优先级要低。发送方在send...
- Arduino通过串口透传ESP 13板与java程序交互
-
ESP13---是一个无线板子，配置通过热点通信Arduino通过串口透传ESP13板与java程序交互...
- zookeeper的Leader选举源码解析（zookeeper角色选举角色包括）
-
作者：京东物流梁吉超zookeeper是一个分布式服务框架，主要解决分布式应用中常见的多种数据问题，例如集群管理，状态同步等。为解决这些问题zookeeper需要Leader选举进行保障数据的强一致...
- 接待外国人英文口语（接待外国友人的英语口语对话）
-
接待外国人英文口语询问访客身份： MayIhaveyourname,please? 请问您贵姓？ Whatcompanyareyoufrom? 您是哪个公司的？ Could...
- 一文深入理解AP架构Nacos注册原理
-
Nacos简介Nacos是一款阿里巴巴开源用于管理分布式微服务的中间件，能够帮助开发人员快速实现动态服务发现、服务配置、服务元数据及流量管理等。这篇文章主要剖析一下Nacos作为注册中心时其服务注册与...
- Android面试宝典之终极大招（android面试及答案）
-
以下内容来自兆隆IT云学院就业部，根据多年成功就业服务经验，以及职业素养课程部分内容，归纳总结：18.请描述一下Intent和IntentFilter。Android中通过Intent...
- 除了Crontab，Swoole Timer也可以实现定时任务的
-
一般的定时器是怎么实现的呢？我总结如下：1.使用Crontab工具，写一个shell脚本，在脚本中调用PHP文件，然后定期执行该脚本；2.ignore_user_abort()和set_time_li...
- Spark源码阅读:DataFrame.collect 作业提交流程思维导图
-
本文分为两个部分：作业提交流程思维导图关键函数列表作业提交流程思维导图...
- 使用Xamarin和Visual Studio开发Android可穿戴设备应用
-
搭建开发环境我们需要做的第一件事情是安装必要的工具。因此，你需要首先安装VisualStudio。如果您使用的是VisualStudio2010，2012或2013，那么请确保它是一个专业版本或...
- Android开发者必知的5个开源库（android 开发相关源码精编解析）
-
过去的时间里，Android开发逐步走向成熟，一个个与Android相关的开发工具也层出不穷。不过，在面对各种新鲜事物时，不要忘了那些我们每天使用的大量开源库。在这里，向大家介绍的就是，在这个任劳任怨...
- Android事件总线还能怎么玩?（android实现事件处理的步骤）
-
顾名思义，AndroidEventBus是一个Android平台的事件总线框架，它简化了Activity、Fragment、Service等组件之间的交互，很大程度上降低了它们之间的耦合，使我们的代码...
- Android 开发中文引导-应用小部件
-
应用小部件是可以嵌入其它应用（例如主屏幕）并收到定期更新的微型应用视图。这些视图在用户界面中被叫做小部件，并可以用应用小部件提供者发布。可以容纳其他应用部件的应用组件叫做应用部件的宿主（1）。下面的截...
欢迎 你 发表评论:
- 一周热门
-
-
前端面试:iframe 的优缺点? iframe有那些缺点
-
带斜线的表头制作好了，如何填充内容?这几种方法你更喜欢哪个?
-
漫学笔记之PHP.ini常用的配置信息
-
推荐7个模板代码和其他游戏源码下载的网址
-
其实模版网站在开发工作中很重要，推荐几个参考站给大家
-
[干货] JAVA - JVM - 2 内存两分 [干货]+java+-+jvm+-+2+内存两分吗
-
正在学习使用python搭建自动化测试框架?这个系统包你可能会用到
-
织梦(Dedecms)建站教程 织梦建站详细步骤
-
【开源分享】2024PHP在线客服系统源码(搭建教程+终身使用)
-
2024PHP在线客服系统源码+完全开源 带详细搭建教程
-
- 最近发表
-
- 自卑的人容易患抑郁症吗?（自卑会导致抑郁吗）
- 中考典型同(近)义词组（同义词考题）
- WPF 消息传递简明教程（wpf messagebox.show）
- BroadcastReceiver的原理和使用（broadcast-suppression）
- Arduino通过串口透传ESP 13板与java程序交互
- zookeeper的Leader选举源码解析（zookeeper角色选举角色包括）
- 接待外国人英文口语（接待外国友人的英语口语对话）
- 一文深入理解AP架构Nacos注册原理
- Android面试宝典之终极大招（android面试及答案）
- 除了Crontab，Swoole Timer也可以实现定时任务的
- 标签列表
-
- mybatis plus (70)
- scheduledtask (71)
- css滚动条 (60)
- java学生成绩管理系统 (59)
- 结构体数组 (69)
- databasemetadata (64)
- javastatic (68)
- jsp实用教程 (53)
- fontawesome (57)
- widget开发 (57)
- vb net教程 (62)
- hibernate 教程 (63)
- case语句 (57)
- svn连接 (74)
- directoryindex (69)
- session timeout (58)
- textbox换行 (67)
- extension_dir (64)
- linearlayout (58)
- vba高级教程 (75)
- iframe用法 (58)
- sqlparameter (59)
- trim函数 (59)
- flex布局 (63)
- contextloaderlistener (56)