Swagger 正在参加 2020 年度 OSC 中国开源项目评选,请投票支持!
Swagger 在 2020 年度 OSC 中国开源项目评选 中已获得 {{ projectVoteCount }} 票,请投票支持!
投票让它出道
已投票
Swagger 获得 2020 年度 OSC 中国开源项目评选「最佳人气项目」 !
Swagger 获得 2020 年度 OSC 中国开源项目评选「最佳人气项目」「最积极运营项目」 !
Swagger 获得 2020 年度 OSC 中国开源项目评选「最积极运营项目」 !
授权协议 Apache
开发语言 Java 查看源码 »
操作系统 跨平台
软件类型 开源软件
开源组织
地区 不详
投 递 者 红薯
适用人群 未知
收录时间 2012-09-19

软件简介

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

总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法、参数和模型紧密集成到服务器端的代码,允许 API 来始终保持同步。Swagger 让部署管理和使用功能强大的 API 从未如此简单。

Swagger

展开阅读全文

代码

的 Gitee 指数为
超过 的项目

评论 (21)

加载中
apizza 要收费吧
04/21 09:49
回复
举报
我们公司都在用 apizza ,测试完就可以自动生成文档。不用侵入代码。https://www.apizza.net?s1
2020/11/12 11:39
回复
举报
这广告打得好
2020/11/16 22:56
回复
举报
侵入式
2020/10/16 09:53
回复
举报
说污染代码的,是代码没写法
2018/11/16 10:07
回复
举报
打分: 还行
代码入侵
2018/03/10 11:39
回复
举报
打分: 还行
用它做API文档还是挺不错的
2018/03/10 11:28
回复
举报
打分: 还行
这里我给打3颗星。就像上面说的,确实有点污染代码,而且在项目开始的时候用比较合适,中途加入的话效果不尽人意。。我不推荐用他的代码生成,至少他的代码风格和我是不一样的。用它做API文档还是不错的,方便不同团队之间的配合。小团队的话就不如当面喊一嗓子来的快。
2017/10/10 09:59
回复
举报
打分: 还行
前后端绑死了~~除非一开始就用这套,后来的都接不上的
2017/09/14 12:24
回复
举报
打分: 力荐
不错。
2017/08/17 01:07
回复
举报
开发效率降低 并且真的不好看 污染代码
2017/08/04 15:52
回复
举报
更多评论
2018/04/17 16:45

Swagger Core 2.0.1 发布,构建时支持 JDK 9/10

Swagger Core 2.0.1 已发布,该版本主要是修复 bug,也引入了新特性,如对 JDK 9/10 的支持。 有以下值得关注的更新: JDK 9/10 support in build (#2735) Supports OpenAPIExtension decorateOperation (#2748) Fix path building for resources without leading slashes (#2751) Fix stackOverflowError for circuclar reference in jackson ModelResolver (#2740) Fix CVE-2018-7489 - jackson version 2.9.5 (#2755) Fix ra...

1
1
发表于服务端专区
2018/03/28 15:56

Swagger-core v2.0.0 发布,只生成 OpenAPI 3.0 规范

2.0.0 版本在 rc4 版本的基础上对 OpenAPI 3.0 主要特性作了增加支持。 显著特性更新包括但不限于: 首次正式支持 OpenAPI 3.0。Swagger-core 现在只生成 OpenAPI 3.0 规范,它不向后兼容 v1.x。 支持 Maven,源码位于 2.0 分支,pull requests 应该针对 2.0 分支提交。 全新的 wiki。 支持 JsonView。 内部重构。 弃用 Schema.readOnly 并引入 accessMode 字段。 复杂类型支持 @extensionproperty。 同时修复了一些 bug: 阅读...

1
7
发表了资讯
2017/07/17 14:14

Swagger 1.5.16 发布,RESTful 风格的 Web 服务框架

Swagger 1.5.16 已发布,Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。 该版本未提供最新的发行说明,了解更多可查阅发行列表 下载地址: Source code (zip) Source code (tar.gz)

4
30
发表了资讯
2017/06/15 14:56

Swagger 1.5.14 发布,RESTful 风格的 Web 服务框架

Swagger 1.5.14 已发布。v1.5.14 添加了一些功能,修复了一些问题。 新功能: 升级 logback 至 1.2.3 #2182 来自命名空间注释更好的支持 XML #2246 支持 Jackson 的 @JsonSerializeAs 注释 #2147 升级 .equals 和 .hashcode #2168 Support getter-less model scanning #2251 修复: Null check in setRequired(...) method in ModelImpl #2167 Null check for empty array inner properties #2214 下载地址 Source code (zip) ...

3
27
发表了资讯
2016/06/27 00:00

Swagger 高危漏洞影响 Java、PHP 和 Ruby等语言

广泛使用的Swagger规格(今 年初重命名为OpenAPI)发现了高危漏洞,潜在影响到了Java、PHP、NodeJS和 Ruby等流行语言开发的应用。该漏洞允许攻击者远程执行代码,存在于Swagger Code Generator中,属于参数注入漏洞,允许攻击者在Swagger JSON文件中嵌入代码,使用Java、PHP、NodeJS和 Ruby等语言开发的Web应用如果整合了 Swagger API会受到影响。Rapid7研究人员公开了漏洞的技术细节和补丁,该漏洞早在4月就在私下披露过了,但...

7
9
发表了资讯
2016/05/16 00:00

Swagger Core 1.5.9 发布,RESTful 框架

Swagger-Core 1.5.8 发布了,Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。 Swagger 让部署管理和使用功能强大的API从未如此简单。 下载地址: Source code (zip) Source code (tar.gz)...

9
34
发表了资讯
2016/03/12 00:00

Swagger-Core 1.5.8 发布,RESTful 框架

Swagger-Core 1.5.8 发布了,Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。 Swagger 让部署管理和使用功能强大的API从未如此简单。 该版本值得关注的改进有: Notable features Allow user created @PATCH, @GET ...etc annotations (#1643) ...

4
45
发表了资讯
2015/11/07 00:00

Linux 基金会联合谷歌微软推出“开放 API 战略”

近日,Linux 基金会宣布推出“开放 API 战略”( Open API Initiative )以促成一个更加广泛、开放的 API 标准,创始成员包括谷歌、微软、IBM 等科技巨头,这项战略基于现有的 Swagger (已收录开源中国软件库 )标准展开。 Swagger 是一个开源的平台,帮助开发者创建支持互联网应用的 API。这些 API 可以让不同的应用之间互相分享信息和资源。 Swagger 被认为是目前最流行的创建 API 的框架。Linux 基金会的执行总监 Jim Zeml...

6
31
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
2018/12/26 15:46

swagger的swagger例子

{ "swagger": "2.0", "info": { "description": "这里主要写的是OA4R项目接口的文档", "version": "1.0.0", "title": "新项目接口", "termsOfService": "http://swagger.io/terms/", "contact": { "email": "xjx@auldey.com" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" } }, "host": "localh...

0
0
发表于程序人生专区
2020/12/17 15:24

Swagger

认识Swagger: Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。 作用: 1. 接口的文档在线自动生成。 2. 功能测试。 Swagger使用的注解及其说明: @Api:用在类上,说明该类的作用。@ApiOperation:注解来给API增加方法说明。@ApiImplicitParams ...

0
0
发表了博客
2018/12/06 19:04

swagger

随着互联网技术的发展,现在的网站架构基本都由原来的后端渲染,变成了:前端渲染、先后端分离的形态,而且前端技术和后端技术在各自的道路上越走越远。 前端和后端的唯一联系,变成了API接口;API文档变成了前后端开发人员联系的纽带,变得越来越重要,swagger就是一款让你更好的书写API文档的框架。 其他API文档工具 没有API文档工具之前,大家都是手写API文档的,在什么地方书写的都有,有在confluence上写的,有在对应的项目...

0
0
发表了博客
2019/07/24 17:35

swagger

Swagger-ui 今天在看一只新项目的时候发现酱样 还有酱样 这都是啥,好奇心溢出…… Swagger– The World's Most Popular Framework for APIs Swagger由来和优势 现在多数的项目开发中,网站和移动端都需要进行数据交互和对接,这少不了使用REST编写API接口这种场景。 特别是不同开发小组协作时,就更需要以规范和文档作为标准和协作基础。良好的文档可以减少沟通成本,达到事半功倍的效果。 有时对一些API说明的理解比较模糊,总...

0
0
发表了博客
2018/12/11 10:39

Swagger

前后端分离: 1.前端--前端控制层、视图层 2.后端--后端控制层、服务层、数据访问层 3.前端在没有API的情况下,可以完美的运行。前端负责展现,后端负责数据 4.前后端相对独立且耦合 问题: 前后端集成-----CI/CD 前端或者后端无法做到“及时协商,尽早解决”最终导致集中爆发 解决方案 首先定义schema,并实时跟踪最新的API,降低集成风险 swagger的作用: 1.restful API文档在线自动更新 2.直接运行,在线测试API 3.支持多种语...

0
0
发表了博客
2018/01/09 15:35

Swagger

最近自己项目要用到这个方便接口管理 就自己去找了些资料 方便自己用 maven: pom.xml中添加 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.5.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.5.0</version> </dependency> 添加完事后 增加一个class /** * Created by wjs */ @Co...

0
0
发表于开发技能专区
2019/07/10 10:53

swagger

请求地址:http://localhost:8080/server.context-path/swagger-ui.html maven依赖: <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.8.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.8.0</version> </dependency> swagger配置类 import org.s...

0
0
发表了博客
2019/06/05 14:51

Swagger

Swagger 1:认识Swagger Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。 作用: 1. 接口的文档在线自动生成。 2. 功能测试。 Swagger是一组开源项目,其中主要要项目如下: \1. Swagger-tools:提供各种与Swagger进行集成和交互的工具。例如模式...

0
0
发表了博客
2019/05/31 17:28

swagger

[swagger.io](https://swagger.io) ``` 下载并启动 swagger-editor,通过npm 启动, 编写 json或yaml 文档,生成 应用服务 启动服务,通过浏览器访问,即可查看接口文档。 或者 启动swagger-ui,将 接口文档放入swagger-ui项目下,访问文档路径即可。 ```

0
0
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
06/10 07:10

knife4j无法正常显示,请求webjars/js/chunk-vendors.9ff0f717.js的时候出现乱码

集成springmvc的时候出现请求webjars/js/chunk-vendors.9ff0f717.js的时候出现异常的乱码,导致文档无法正常显示 使用的版本是 检查了web.xml的配置,配置了UniEncoding为UTF-8,knife4j的作者的demo项目knife4j-spring-mvc-demo请求 ebjars/js/chunk-vendors.9ff0f717.js显示正常如下 正常的应该是...

1
0
发表于软件架构专区
05/13 11:30

请问swagger注解可以作用于非controller的方法或者类上吗?

类似于此

1
0
05/25 16:28

求助:We're sorry but knife4j-vue doesn't work properly without JavaScript enabled.

We're sorry but knife4j-vue doesn't work properly without JavaScript enabled. Please enable it to continue. 谢谢各位大佬

1
0
05/13 17:35

使用JRebel 启动,响应参数不显示的问题有什么解决办法吗

JRebel 版本 2021.2.1 knife4j 版本2.0.8

1
0
04/07 10:21

knife4j中aggregation组件如何进行用户权限认证

aggregation采用cloud或者eureka模式。微服务为springcloud框架,每个微服务采用knife4j设置了用户名密码。但使用aggregation时,浏览器并不会自动弹框让用户输入用户名密码,而是需要在aggregation配置用户名密码。期望能在aggregation中弹框输入basic认证,起到对不同用户鉴权的效果。不知道是否有相关的方法?

2
0
03/19 10:48

knife4j两个问题

问题1:我有配置说明,但是文档这边却无法显示,是否目前不支持呢? 问题2:自定义Footer不生效?配置如下

4
0
发表于开发技能专区
01/21 16:04

swagger的PUT请求中参数使用query的方式无法接收到入参

3
0
发表于开发技能专区
01/14 13:40

swagger+gateway聚合文档,baseUrl丢失

怎么回事呀,这个内容一保存就网络错误

7
0
2020/12/24 10:26

List<String> 字段名使用 @ApiModelProperty(value = "") 注解之后响应示例无法显示

@ApiModelProperty(value = "服务保证") private List<String> serviceTerms;//服务保证 可以看到实际上已经被识别出了是List<String>类型 但是在响应示例中无法显示出实际的类型 删掉@ApiModelProperty(value = "服务保证") 注解就好了,但是就看不到注释了 List<T> 也是如此,这里T是自定义类型

3
0
2020/12/16 22:59

返回类的数据封装

统一返回类中的数据类型怎么可以进行多级展示,在data的字符串的里面进行展示 理想样式

3
0
发表于大前端专区
2019/02/27 12:14

spring boot swagger-ui文档的输入参数是否可分情况处理?

比如用户的增删改查的操作; 增加的时候参数没有id; 修改的时候必须要传id; id只是举例说明,可能会是其它属性; 目前swagger是否可以处理这类问题呢?

1
0
2020/09/17 22:38

如何把json数据注册到swagger?

项目架构是自己封装的,之前没用到swagger,现在想用,架构是可以拿到所有接口的信息的json数据,现在我的问题是如何把这个json数据注册到swagger?

4
0
2018/12/18 10:02

swagger设置全局参数(例如token),但是部分接口不需要该全局参数,如何配置?

如题,给swagger配置了一个全局的参数token,但是部分的接口不需要该参数(如登录接口),如何单独的将该接口的参数进行屏蔽(不在页面显示)呢? 以下为swagger基础配置:

7
1
发表于服务端专区
2020/03/16 15:38

java web项目使用swagger时,能否让一个controller中的指定方法生成接口文档,没指定的不生成

在一个controller中有多个方法,有没有办法仅仅让这个controller中的某些方法生成接口文档,而不是全部都sheng'c

2
0
发表于软件架构专区
2019/10/17 09:56

java运行时,如何分析一个Method中会调用哪些方法,关联的引用.

如题目. 想法来源于swagger在生成API的时候, 扫描相关的引用,检测出自定义的业务异常code, 去补充文档, 有没有相关的jar包去帮忙分析method有哪些代码? 还有一种想法, 做maven插件预生成, 像idea一样能关联引用, 但是不知道这相关的技术

1
1
发表于AI & 大数据专区
2018/01/16 21:29

Spring boot Swagger怎么扫描包下面的指定类(不想生成包下所有controller的接口)

在使用spring boot的时候,利用Swagger生成接口文档, 只想生成指定类的接口文件。 如图:包下面所有的都会生成 怎么做,得到指定类的接口了。

4
2
2018/07/06 16:32

swagger 内部类的问题

使用swagger生产在线api文档时,我的多个响应BO里定义了同名的内部类,如下: //class-A public class AQueryRsp extends CommonRsp { @ApiModelProperty(value = "响应内容") private Content content; public static class Content { private String p1; } } //class-B public class BQueryRsp extends CommonRsp { @ApiModelProperty(value = "响应内容") private Content content; ...

4
0
2018/03/23 10:59

SwaggerUI 在传递嵌套对象时,怎么使嵌套对象的描述在前端显示?

以上是代码 下面是效果 我想要atttachments能显示它的JSON格式

2
0
2019/06/17 14:14

本地测试时,swagger显示页面时,不显示接口,页面空白,需要等五分钟才显示,重启tomcat后也不行

本地测试时,swagger显示页面时,不显示接口,页面空白,需要等五分钟才显示,重启tomcat后也不行

3
0
发表于软件架构专区
2019/03/04 20:44

swagger 中@ApiImplicitParam()跟@ApiParam()两个注解的区别

swagger 中@ApiImplicitParam()跟@ApiParam()两个注解的区别?

1
0
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
21 评论
410 收藏
分享
OSCHINA
登录后可查看更多优质内容
返回顶部
顶部