百度360必应搜狗淘宝本站头条
vba高级教程svn连接scheduledtaskmybatis plus结构体数组
当前位置：网站首页 > 编程网 > 正文

推荐一款API神器Swagger 推荐一款几百元调音台比较好

yuyutoo 2024-10-12 01:49 4 浏览 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！

相关推荐

Mysql和Oracle实现序列自增（oracle创建序列的sql）

Mysql和Oracle实现序列自增/*ORACLE设置自增序列oracle本身不支持如mysql的AUTO_INCREMENT自增方式，我们可以用序列加触发器的形式实现，假如有一个表T_WORKM...

关于Oracle数据库12c 新特性总结（oracle数据库19c与12c）

概述今天主要简单介绍一下Oracle12c的一些新特性，仅供参考。参考：http://docs.oracle.com/database/121/NEWFT/chapter12102.htm#NEWFT...

MySQL CREATE TABLE 简单设计模板交流

推荐用MySQL8.0(2018/4/19发布,开发者说同比5.7快2倍)或同类型以上版本....

mysql学习9:创建数据库（mysql5.5创建数据库）

前言：我也是在学习过程中，不对的地方请谅解showdatabases;#查看数据库表createdatabasename...

MySQL面试题-CREATE TABLE AS 与CREATE TABLE LIKE的区别

执行"CREATETABLE新表ASSELECT*FROM原表;"后，新表与原表的字段一致，但主键、索引不会复制到新表，会把原表的表记录复制到新表。...

Nike Dunk High Volt 和 Bright Spruce 预计将于 12 月推出

在街上看到的PandaDunk的超载可能让一些球鞋迷们望而却步，但Dunk的浪潮仍然强劲，看不到尽头。我们看到的很多版本都是为女性和儿童制作的，这种新配色为后者引入了一种令人耳目一新的新选择，而...

美国多功能舰载雷达及美国海军舰载多功能雷达系统技术介绍

多功能雷达AN/SPY-1的特性和技术能力，该雷达已经在美国海军服役了30多年，其修改-AN/SPY-1A、AN/SPY-1B（V）、AN/SPY-1D、AN/SPY-1D（V），以及雷神...

汽车音响怎么玩，安装技术知识（汽车音响怎么玩,安装技术知识视频）

全面分析汽车音响使用或安装技术常识一:主机是大多数人最熟习的音响器材，有关主机的各种性能及规格，也是耳熟能详的事，以下是一些在使用或安装时，比较需要注意的事项：LOUDNESS：几年前的主机，此按...

【推荐】ProAc Response系列扬声器逐个看

有考牌(公认好声音)扬声器之称ProAcTablette小音箱，相信不少音响发烧友都曾经，或者现在依然持有，正当大家逐渐掌握Tablette的摆位设定与器材配搭之后，下一步就会考虑升级至表现更全...

#本站首晒# 漂洋过海来看你 — BLACK&DECKER 百得 BDH2000L无绳吸尘器 开箱

作者：初吻给了烟sco混迹张大妈时日不短了，手没少剁。家里有了汪星人，吸尘器使用频率相当高，偶尔零星打扫用卧式的实在麻烦（汪星人：你这分明是找借口，我掉毛是满屋子都有，铲屎君都是用卧式满屋子吸的，你...

专题|一个品牌一件产品(英国篇)之Quested(罗杰之声)

Quested(罗杰之声)代表产品：Q212FS品牌介绍Quested(罗杰之声)是录音监听领域的传奇品牌，由英国录音师RogerQuested于1985年创立。在成立Quested之前，Roger...

常用半导体中英对照表(建议收藏)（半导体英文术语）

作为一个源自国外的技术，半导体产业涉及许多英文术语。加之从业者很多都有海外经历或习惯于用英文表达相关技术和工艺节点，这就导致许多英文术语翻译成中文后，仍有不少人照应不上或不知如何翻译。为此，我们整理了...

Fyne Audio F502SP 2.5音路低音反射式落地音箱评测

FyneAudio的F500系列，有新成员了！不过，新成员不是新的款式，却是根据原有款式提出特别版。特别版产品在原有型号后标注了SP字样，意思是SpecialProduction。Fyne一共推出...

有哪些免费的内存数据库(In-Memory Database)

以下是一些常见的免费的内存数据库：1.Redis：Redis是一个开源的内存数据库，它支持多种数据结构，如字符串、哈希表、列表、集合和有序集合。Redis提供了快速的读写操作，并且支持持久化数据到磁...

RazorSQL Mac版(SQL数据库查询工具)

RazorSQLMac特别版是一款看似简单实则功能非常出色的SQL数据库查询、编辑、浏览和管理工具。RazorSQLformac特别版可以帮你管理多个数据库，支持主流的30多种数据库，包括Ca...

取消回复欢迎 你 发表评论:

一周热门
最近发表
标签列表