写点什么

swagger

0 人感兴趣 · 45 次引用

  • 最新
  • 推荐

使用 OpenAPI 构建 API 文档

作为一名开发者,往往需要编写程序的 API 文档,尤其是 Web 后端开发者,在跟前端对接 HTTP 接口的时候,一个好的 API 文档能够大大提高协作效率,降低沟通成本,本文就来聊聊如何使用 OpenAPI 构建 HTTP 接口文档。

还担心接口乱糟糟?快来试试“斯瓦格”在线文档管理平台!

用户头像
wljslmz
2022-11-05

在开发过程中,前后端最糟心的事就是沟通接口,在此过程中,吵得最凶的根源就在于接口文档的不完善、乱、难于使用,甚至都没有统一管理接口的地方。本文将分享一款在线接口文档管理工具:“斯瓦格”,同时我将用华为AppCloud进行搭建,每一步都会记录下来,如

Swagger-knife4j 介绍

用户头像
默默的成长
2022-11-02

Knife4j的前身是swagger-bootstrap-ui,前身swagger-bootstrap-ui是一个纯swagger-ui的ui皮肤项目

https://static001.geekbang.org/infoq/f9/f9c9ccdd5c52490588c7771238d03580.png?x-oss-process=image%2Fresize%2Cw_416%2Ch_234

SpringBoot 整合 Swagger 自动生成在线 API 文档

用户头像
宁在春
2022-07-27

现在大都数项目都已是前后端分离的啦,那么接口文档就成了项目中非常重要的一部分啦,SpringBoot整合Swagger可以自动生成RESTFUL风格的API文档,也可以在其中进行测试,比起以前手写的文档,不仅方便很多,而且也易于修改和测试。

接口文档进化图鉴,有些古早接口文档工具,你可能都没用过

用户头像
Liam
2022-07-21

可能现在的小程序员听到以前还有人用过 word 来做接口文档,会惊讶得不行,但在前后端分离推行的早期,确实没有那么多趁手好用的接口文档工具。

超高效!Swagger-Yapi 的秘密

用户头像
百度Geek说
2022-07-05

本文仅作为一个快速上手入门swagger到yapi的方法,通道搭建好之后,更多的用法就可以各位同学自己去挖掘。

SpringBoot 工程创建 Swagger 文档并自动生成调用代码

Java后台如何更好的提供暴露接口的信息?今天教大家一种借助Swagger文档进行调用代码生成的方法。

前后端的爱恨情仇

用户头像
Liam
2022-06-16

随着最近行业的移动化、物联网化、数字化转型、微服务等多种概念的提出,对应的API数量已经呈现出爆炸式增长,由此带来的问题就是前后端的接口对接问题越来越来突出,我们能很难找到一个合适的技术工具提高我们的效率。由此带来的问题就是接口对接的繁琐,前

https://static001.geekbang.org/infoq/40/4071f06f275f486e0995bb36a7dfdeb5.png?x-oss-process=image%2Fresize%2Cw_416%2Ch_234

实战 |SpringBoot 增加 Swagger

​SpringBoot 整合swagger文档过程及相应代码分享

为什么越来越多的开发者放弃使用 Postman,而选择 Apifox

用户头像
Liam
2022-06-07

作为一个后端开发,我做的大部分项目一般都是基于 Swagger 来管理 API 文档,基于 Postman 来做接口调试,基于 JMeter 来做接口性能测试,基于 RAP 等工具 Mock API 数据。

https://static001.geekbang.org/infoq/15/15112c00a7670a72ad4ef401d36c21ae.png?x-oss-process=image%2Fresize%2Cw_416%2Ch_234

集齐多种功能的团队协作软件!

用户头像
Liam
2022-04-29

做技术 管理的童鞋,往往会陷入这样一种困境:疲于奔命,到处救火填坑,沟通推进,却挤不出时间思考对团队和项目来说真正重要的事情。

https://static001.geekbang.org/infoq/b3/b3bca0dad7269741bf412ef1ce463292.jpeg?x-oss-process=image%2Fresize%2Cw_416%2Ch_234

post 接口请求测试,通俗易懂!

用户头像
Liam
2022-04-20

http请求方法get和post是最常被用到的两个方法,get常用于向服务器请求数据,post常用于提交数据给服务器处理。GET方法其实也可以传递少量的数据。但它存在以下问题:1)GET 方法不包含body,因此以在URL中拼接字段的方式传递数据,2)GET方法中的URL参数会被

https://static001.geekbang.org/infoq/f4/f4df901ce7c9e75d5edaa5b07a7a6496.png?x-oss-process=image%2Fresize%2Cw_416%2Ch_234

一个比 Postman 好用的工具,不试一下?

用户头像
Liam
2022-04-19

作为一名前端,日常开发过程中除了写业务代码,前后端联调更是重要的一环。但这一环却往往是整个开发中最繁琐也最累人的一环。任谁都想早点下班,然而提升联调效率并不是个纯技术相关的问题,而是需要有良好工作流程的问题。

https://static001.geekbang.org/infoq/02/0274f88b10abdddbfdef591b301a096b.png?x-oss-process=image%2Fresize%2Cw_416%2Ch_234

高效进行接口测试,简单易懂!

用户头像
Liam
2022-04-18

日常测试过程中,常常需要多种工具来接力完成自己的接口测试任务。比如说,使用swagger查看接口文档,使用mock编造接口数据对前端页面做测试使用postman测试后端接口,用Jmeter来做接口自动化测试/性能测试。那有没有一款软件可以完美集成以上所有的功能?笔

https://static001.geekbang.org/infoq/ac/acdcab3762cb0b99e3fe43ab8ef937dc.png?x-oss-process=image%2Fresize%2Cw_416%2Ch_234

干掉丑陋的 swagger,堪称开发者的瑞士军刀!

用户头像
Liam
2022-04-14

“为什么改了这个没告诉我”,“实际功能和文档上说的不一样啊”。这些话大家做开发的想必耳朵都听出老茧了。真不是故意的,有时候任务比较急,就先改了代码,想着以后再同步文档,然后就给忘了。项目更新又全靠社交软件通知,人一多难免有一两个没及时沟通到

https://static001.geekbang.org/infoq/a8/a8026498a41ff31c30a873238471b303.png?x-oss-process=image%2Fresize%2Cw_416%2Ch_234

一键智能 Mock,你值得拥有

用户头像
Liam
2022-04-13

大家好呀,我是一名苦逼的前端开发工程师,为啥苦逼呢,这不,项目下周就要上线了,但是后端还没给我接口,没有接口我就无法调试,工作停滞不前,我也只能坐着干着急。

https://static001.geekbang.org/infoq/5a/5a01b488e42d1e46872dc2a53ad4482d.png?x-oss-process=image%2Fresize%2Cw_416%2Ch_234

能直接调试的开放 API?这个 API Hub 绝了

用户头像
Liam
2022-04-06

此前时不时会有一些研发小伙伴和我诉苦,说很多企业由于人力财力限制或者需求不强,会直接购买使用第三方的开放API,这样一来,

swagger2 统一默认 Response Code

用户头像
Rubble
2022-04-05

项目中通常定义一个返回对象Result,对返回对象的说明可以通过@ApiResponse进行说明如下,为每个类都指定精准但比较麻烦,可以通过统一配置的方式为每个请求附带默认的返回值说明。

https://static001.geekbang.org/infoq/04/04771b99afb8cc6294f5e7e53b7cc557.png?x-oss-process=image%2Fresize%2Cw_416%2Ch_234

Postman 中文版客户端

用户头像
Liam
2022-04-02

前端时间,著名 UI 设计软件 Figma 宣布制裁大疆!

https://static001.geekbang.org/infoq/04/04771b99afb8cc6294f5e7e53b7cc557.png?x-oss-process=image%2Fresize%2Cw_416%2Ch_234

汉化版 postman

用户头像
Liam
2022-03-29

作为软件开发从业者,API 调试是必不可少的一项技能,在这方面 Postman 做的非常出色。但是在整个软件开发过程中,API 调试只是其中的一部分,还有很多事情 Postman 无法完成,或者无法高效完成,比如:API 文档定义、API Mock、API 自动化测试等等。Apifox

https://static001.geekbang.org/infoq/04/04771b99afb8cc6294f5e7e53b7cc557.png?x-oss-process=image%2Fresize%2Cw_416%2Ch_234

中文版 Postmna

用户头像
Liam
2022-03-25

作为软件开发从业者,API 调试是必不可少的一项技能,在这方面 Postman 做的非常出色。但是在整个软件开发过程中,API 调试只是其中的一部分,还有很多事情 Postman 无法完成,或者无法高效完成,比如:API 文档定义、API Mock、API 自动化测试等等。Apifox

https://static001.geekbang.org/infoq/04/04771b99afb8cc6294f5e7e53b7cc557.png?x-oss-process=image%2Fresize%2Cw_416%2Ch_234

国产版 Postman

用户头像
Liam
2022-03-24

作为软件开发从业者,API 调试是必不可少的一项技能,在这方面 Postman 做的非常出色。但是在整个软件开发过程中,API 调试只是其中的一部分,还有很多事情 Postman 无法完成,或者无法高效完成,比如:API 文档定义、API Mock、API 自动化测试等等。Apifox

https://static001.geekbang.org/infoq/a8/a8026498a41ff31c30a873238471b303.png?x-oss-process=image%2Fresize%2Cw_416%2Ch_234

不仅仅是一把瑞士军刀 —— Apifox 的野望和不足

用户头像
Liam
2022-03-23

声明:本文内容不涉及任何 Apifox 的功能介绍,一来网上这方面的文章已经汗牛充栋,二来 Apifox 本身的用户体验做的非常好,对于开发者而言学习成本基本为零。

https://static001.geekbang.org/infoq/04/04771b99afb8cc6294f5e7e53b7cc557.png?x-oss-process=image%2Fresize%2Cw_416%2Ch_234

中国版 Postman:Apifox

用户头像
Liam
2022-03-22

作为软件开发从业者,API 调试是必不可少的一项技能,在这方面 Postman 做的非常出色。但是在整个软件开发过程中,API 调试只是其中的一部分,还有很多事情 Postman 无法完成,或者无法高效完成,比如:API 文档定义、API Mock、API 自动化测试等等。Apifox

https://static001.geekbang.org/infoq/a6/a6fb008eb1d21540634a9c402df8978c.jpeg?x-oss-process=image%2Fresize%2Cw_416%2Ch_234

在 Node.js 中使用 Yaml 编写 API 文档

用户头像
devpoint
2022-03-20

在文章《使用Node.js、MongoDB、Fastify 构建API服务》中介绍使用 Swagger 构建 API 文档,编写文档不是那么的顺手,本文介绍另一种编写 API 文档的方式,即使用 Yaml ,将API文档与其实现完全分开。

https://static001.geekbang.org/infoq/88/88868f5eff34c680849d9bb698289693.jpeg?x-oss-process=image%2Fresize%2Cw_416%2Ch_234

使用 Node.js、MongoDB、Fastify 构建 API 服务

用户头像
devpoint
2022-03-19

在现代WEB开发中,数据交互是主要需求,那么对于前后端数据交互来说,REST API 就是其中的数据交互设计的一种,本文介绍使用 Node.js、MongoDB、Fastify 和 Swagger快速构建API。

https://static001.geekbang.org/infoq/3c/3c43343d89e4ce01e3a205b8e6e0276a.png?x-oss-process=image%2Fresize%2Cw_416%2Ch_234

Apifox 才是最强 Postman 替代品,看看国产软件到底有对牛!

用户头像
Liam
2022-03-18

作为软件开发从业者,API 调试是必不可少的一项技能,在这方面 Postman 做的非常出色。但是在整个软件开发过程中,API 调试只是其中的一部分,还有很多事情 Postman 无法完成,或者无法高效完成,比如:API 文档定义、API Mock、API 自动化测试等等。Apifox

swagger_swagger技术文章_InfoQ写作社区