文章目录1、为什么需要规范2、接口文档的形式和定义3、接口文档的详细规范3.1 Format3.2 文档结构：Document Structure3.3 数据类型：Data Types3.4 富文本格式3.5 Schema4、示例 参考文档： Swagger Specification1、为什么需要规范接口的使用者（front-end developer），调用者（client），提供者（ser
转载
2023-12-31 16:51:51
474阅读
《前言》（一） Winner2.0 框架基础分析（二）PLSQL报表系统（三）SSO单点登录（四） 短信中心与消息中心（五）钱包系统（六）GPU支付中心（七）权限系统（八）监控系统（九）会员中心（十） APP版本控制系统（十一）Winner前端框架与RPC接口规范讲解（十二）上层应用案例（十三）总结 《RPC接口使用规范》 不知道啥时候开始好像一下子都流行叫“RPC”了。之前我
转载
2024-05-13 20:32:03
54阅读
OpenAPI规范
原创
2021-09-14 15:44:20
606阅读
背景本人自己使用的swagger2.0，鉴于颜值和OpenAPI规范，就想体验下，后续再补充各种情况的demo。一、什么是swagger？OpenAPI规范(OpenAPI Specification 简称OAS)是Linux基金会的一个项目，试图通过定义一种用来描述API格式或API定义的语言，来规范RESTful服务开发过程。目前V3.0版本的OpenAPI规范(也就是SwaggerV2.0规
转载
2024-06-08 11:05:01
961阅读
1.Swagger简介1.1.前言接口文档对于前后端开发人员都十分重要。尤其近几年流行前后端分离后接口文档又变成重中之重。接口文档固然重要，但是由于项目周期等原因后端人员经常出现无法及时更新，导致前端人员抱怨接口文档和实际情况不一致。很多人员会抱怨别人写的接口文档不规范，不及时更新。但是当自己写的时候确实最烦去写接口文档。这种痛苦只有亲身经历才会牢记于心。如果接口文档可以实时动态生成就不会出现上面
转载
2024-03-31 11:28:54
1850阅读
由于API对于我们的软件运行方式至关重要，因此记录我们的API对于确保我们大型IT组织中的每个人都了解正在发生的事情至关重要，这就是我们使用OpenAPI来帮助记录API规范的原因。 在本文中，我将向你介绍OpenAPI规范和API-First开发原则。 OpenAPI规范 OpenAPI规范始于S
转载
2019-08-14 07:01:00
348阅读
文章目录1.Swagger3和AOP结合的好处2.Swagger需要做什么3.AOP需要做什么4.完整代码示例 1.Swagger3和AOP结合的好处当我们使用接口，或者问题定位，我们需要知道这么几个比较常见的信息：这个接口干嘛用的？这个接口的请求地址，请求方式，请求参数，返回参数都是什么样？这个接口的代码在哪里？当这个接口出现问题时，当时的运行的参数是什么？如果你的项目中用了Swagger，你
转载
2024-09-10 09:51:34
151阅读
# OpenAPI接口规范 Java代码解析与生成
OpenAPI（前称Swagger）是一种用于定义RESTful APIs的规范。它以JSON或YAML格式描述API，支持自动化生成文档、客户端 SDK 和服务器代码。在本文中，我们将探讨如何通过Java解析和生成OpenAPI接口规范，并提供相关代码示例。
## OpenAPI基础
OpenAPI规范由三个主要部分组成：
1. **信
原创
2024-09-24 05:55:52
892阅读
通用要求 接口命名小驼峰 如果不是restfull的接口，需要语义化，例如：getUserInfo、getUserList、createUser、updateUser、deleteUser、uploadUserImg 接口尽量轻巧，前端不需要的数据，不需要返回 后端尽量统一风格，禁止单独适配 为了避免某些Chrome浏览器广告屏蔽插件的误拦截，不使用ad等广告字眼对前端的要求：前端使用axios统
转载
2023-09-04 14:24:18
834阅读
# 实现OpenAPI 3.0规范
OpenAPI 3.0规范是一种描述API的标准格式，可以帮助开发者更好地理解并使用API。在本文中，我将向你介绍如何实现OpenAPI 3.0规范，让你能够快速上手并开始使用。
## 流程
下面是实现OpenAPI 3.0规范的步骤：
| 步骤 | 描述 |
| ---- | ---- |
| 1 | 创建OpenAPI规范文件 |
| 2 | 定义A
原创
2024-05-06 11:28:19
3584阅读
OpenApi & SwaggerUIOpenAPI 规范（OAS）定义了一个标准的、语言无关的 RESTful API 接口规范，它可以同时允许开发人员和操作系统查看并理解某个服务的功能，而无需访问源代码，文档或网络流量检查（既方便人类学习和阅读，也方便机器阅读）。正确定义 OAS 后，开发者可以使用最少的实现逻辑来理解远程服务并与之交互。 Swagger UI 是一个接口文档工具，它遵
转载
2024-04-01 20:43:10
119阅读
之前做项目的时候用到了淘宝 API 就上网去查了一些，总结了一些，现在分享给大家，希望对大家有帮助，先对淘宝 API 做个简介吧：淘宝 OpenAPI（Open application programming interface）是一套 REST 方式的开放应用程序编程接口。淘宝网根据自己提供的电子商务基础服务，抽象并做成一系列的 API 接口。通过这些接口，可以让外部用户能够通过程序的方式访问淘
转载
2023-12-08 12:58:38
151阅读
OpenAPI 接口规范OpenAPI 是描述 HTTP API 的标准方式。今天来讲讲它的接口规范（OpenAPI 规范 (中文版)）~OpenAPI 版本号规范OpenAPI 的版本号是使用 major.minor.patch 格式来定义的，比如 3.1.2major： 规定大版本minor： 规定小版本patch： 规定小版本中的修补OpenAPI 格式规范Op
原创
2023-07-04 17:37:47
507阅读
API 是模块或者子系统之间交互的接口定义。好的系统架构离不开好的 API 设计，而一个设计不够完善的 API 则注定会导致系统的后续发展和维护非常困难。在关键环节制定明确的API规范有助于 Service ……
转载
2021-06-25 17:03:05
601阅读
# 理解OpenAPI接口及其在Java中的实现
在现代软件开发中，API（应用程序编程接口）承担着重要角色。OpenAPI是一种用于描述RESTful API的规范，它使得API的设计、文档生成和客户端生成更加简单和一致。本文将深入探讨OpenAPI接口及其在Java中的实现，并提供相应的代码示例。
## OpenAPI接口概述
OpenAPI接口允许开发者通过一种标准化的方式描述他们的A
OpenAPI规范版本 3.1.0介绍OpenAPI规范（OAS）为HTTP API定义了一个与语言无关的标准接口，使得人和计算机都可以在不使用源代码、文档或监听网络通信的情况下，具备发现和理解服务的能力。正确定义后，使用者可以使用最少的实现逻辑来理解远程服务并与之交互。文档生成工具可以使用OpenAPI定义来显示API，代码生成工具可以生成各种编程语言的服务器和客户端代码，测试工具以及许多其他工
转载
2024-01-28 01:21:45
639阅读
一、RPC1. RPC是什么RPC（Remote Procedure Call Protocol）——远程过程调用协议，它是一种通过网络从远程计算机程序上请求服务，而不需要了解底层网络技术的协议。RPC协议假定某些传输协议的存在，如TCP或UDP，为通信程序之间携带信息数据。在OSI网络通信模型中，RPC跨越了传输层和应用层。RPC使得开发包括网络分布式多程序在内的应用程序更加容易。RPC采用客户
接口设计及文档管理系列 各个工具及概念介绍OpenAPIOpenAPI规范OpenAPI规范的历史OpenAPI描述文档格式OpenAPI 2.0描述文档OpenAPI 3.0描述文档SwaggerSwagger UISwagger EditorSwagger CodegenSwagger HubSwagger InspectorSpringfox Swagger 根据代码（注解）生成接口文档S
转载
2024-02-28 13:13:23
215阅读
HBase是一个分布式的、面向列的开源数据库，该技术来源于 Fay Chang 所撰写的Google论文“Bigtable：一个结构化数据的分布式存储系统”。就像Bigtable利用了Google文件系统（File System）所提供的分布式数据存储一样，HBase在Hadoop之上提供了类似于Big
点击上方“朱小厮的博客”，选择“设为星标”后台回复"书"，获取什么是API规范API 是模块或者子系统之间交互的接口定义。好的系统架构离不开好的 API 设计，而一个设计...
原创
2021-09-15 15:41:42
149阅读
