Swagger annotations （注解）入门到精通

Swagger 提供的注解集是其框架中定义 API 规范和文档的重要工具。这些注解在代码里标注重要部分，为 Swagger 的解析工作铺路，进而生成详尽的 API 文档。开发者编写的注释能够被转换成直观的文档，并展现API端点、参数和响应等信息。这不仅提升了开发人员对 API 运作的理解与沟通，也使...

swagger api api文档接口文档程序员后端前端软件开发

2023-12-22

0 475

怎么写一份好的接口文档？

编写一份优秀的接口文档会让软件开发中变得更加轻松，更有效率。这可是关键任务，写得好不仅可以帮助开发人员更好地理解和使用 API 接口，还可以提高整个团队的协作效率。大家可以在线感受一下优秀的接口文档是怎样的：https://petstore.apifox.cn 那么我们该如何写好一份优秀的接口文...

接口文档 API文档 API 开放API java 后端

2023-02-22

0 301

5分钟打造好用好看API文档

5分钟打造好用好看API文档 🤔️ 你是否遇到过这样的场景？对接第三方开放平台文档的时候，左手刷着接口文档看API，右手操作着接口调试工具 🧱 写完接口想交付或提供API文档给第三方使用，又觉得文档展示体验一般？很鸡肋？前言早期第三方开放平台的开放接口文档，主要以信息展示...

C++ Java API API文档 API设计 postman API调试 swagger mock jmeter

2022-09-27

0 320

满足你对 Api 的所有幻想

一、Api 管理的难点在哪？相信无论是前端，还是后端的测试和开发人员，都遇到过这样的困难。不同工具之间数据一致性非常困难、低效。多个系统之间数据不一致，导致协作低效、频繁出问题，开发测试人员痛苦不堪。开发人员在 Swagger 定义好文档后，接口调试的时候还需要去 Postman 再定义一遍。...

postman swagger jmeter mock API 开放API api文档 api开发工具 api设计 api工具

2022-08-17

0 296

如何模拟后台API调用场景，很细！

简介在开发前后台分离项目并且通过不同团队来实现的时候，如何将后台设计的 API 准确的传达到前台，是一个非常重要的工作。为了简化这个过程，开源社区做了很多努力，比如 protobuf技术，swagger 的诞生，以及后面 openapi 的演化，都在试图解决 API 描述和文档的问题。这些标准某...

Java 前后端分离前端后端 API postman API文档 swagger jmeter mock

2022-08-04

0 439

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

可能现在的小程序员听到以前还有人用过 word 来做接口文档，会惊讶得不行，但在前后端分离推行的早期，确实没有那么多趁手好用的接口文档工具。互联网发展到现在，接口文档也经历了从简单的word到markdown，到swagger，到Apifox 等逐步进化的方式，变得越来越美观，越来越规范，也支持越...

接口文档 api API文档 API开发开放API postman swagger 开发者程序员后端

2022-07-21

0 336

如何高效优雅地管理接口文档

前言你是一个测试，你们团队目前开发模式是前后端分离。某一天，版本V1.0接口评审完，发布在了swagger上，前后端各自进行开发。此时你根据接口文档将新接口迁移到JMeter上，然后开始编写接口测试用例。过了几天，前端先提测了APP，怎么测试前端效果呢，你想到使用charles抓包，造一些假...

API API文档 API接口管理 API管理工具开放API 测试自动化测试测试自动化程序员开发工具

2022-06-28

0 558

API工具--Apifox和Postman对比（区别）

前言 Postman和Apifox有什么区别？他们之间分别有什么优势，感兴趣的同学可以继续往下看。不吹不黑，只列功能，纯客观比对。一.功能列表对比（一）接口设计与文档管理功能 1.导入功能对比 Apifox的导入功能除了支持OpenApi之外，还支持yapi，RAP2，postman等国内用...

Java postman java 后端 API API接口 API管理 API文档接口测试 API工具

2022-06-15

0 502

如何高效的进行接口测试？【工具篇】

一、简介 1、目前接口测试的现状 2、常用方案 3、存在问题开发人员在 Swagger 定义好文档后，接口调试的时候还需要去 Postman 再定义一遍。前端开发 Mock 数据的时候又要去 mockjs 定义一遍，还需要手动设置 Mock 规则。测试人员需要去 JMeter ...

测试 API API接口 API文档测试工具 postman 自动化测试程序员程序猿开发

2022-06-13

0 374

后端适用，Apifox接口文档设计和调试教程【工具篇】

一.Apifox的工具优势对后端研发人员来说，Swagger+Postman 是接口设计和调试的必备工具，这两个工具都非常出色，但不同系统间项目数据不互通，在变更、维护和协同上比较低效，另外是封装程度较低，使用上流程较为繁琐。因此今天介绍一个 API 管理工具，一方面具备 Swagger 和 ...

Java 后端 API文档 API设计开放API 后端开发 Postman swagger jmeter mock

2022-06-09

0 711