只要尝试一次API正向工程,你就会无可救药的爱上她!

news2024/9/20 9:36:48

何为正向,何为反向? 举个例子:在数据库的设计里面这个概念可能被大量涉猎;古早先是 DBA设计好表以及表之间的关系(一对多,多对一,多对多...);然后应用是通过ORM 映射数据库表到业务内领域对象;于是乎大量的数据库反向工程工具就应运而生,很多低代码平台就是这样操作的通过获取数据库schema的元信息,反向生成“智能”表格;新时代的 text2sql, chat2db 都是大致的操作思路;应用程序的质量第一保证在数据库设计, 笔者在职业生涯前期遇到很多大型金融系统里面的应用都是这么个架构,DBA 才是最吃香的, 应用层开发类似于现在的前端,提供一个友好的入口,大部分的业务逻辑在 DB 的存储过程, 有多达数千行的存储过程!

当然现在这部分逻辑大部分迁移到应用程序了, 某种意义上换了个地方挖坑,不过有更多从代码、架构甚至是产品上可操作空间,现代应用程序开发日趋成熟:语言、框架、人才&工程化。DBA 角色渐渐聚集到Paas类基础设施平台(瞎猜),像笔者现在团队,多时有50+开发,有各种角色,就是没有独立的DBA。 开发在数据库应用实践上可以说比一些DBA 还熟练:如何优化索引,如何查看SQL Plan等等。

有反向工程就有正向工程, 言归正传到我们的API 设计开发的世界里,虽然各种工具都上了,开源的商业的;但是你发现团队里面 API 设计和实现始终是断层的, 连反向工程程度都达不到!

写、实现、测试API的人完全是"分裂";设计阶段,迫于整个平台的规范,大家在一些API平台上写了API描述, 实现者如后台JAVA工程师,可“高保真”实现API,达到90%一致性,但不可避免开发中又"悄悄"和前端商量了个新API, 测试的人整了在线表格来誊写测试用例;就在这样一个 “分裂”的状态下,团队歪歪扭扭往前走着, 说不上来好和坏,但总归很是别扭。

更大的隐患,在往后旷日持久的升级更新过程中,多方各执一词,即使在同一个版本迭代不同环境API的细微差异都不能内部保持沟通一致,不满和扯皮在团队内蔓延!

API 作为一个应用对外的脸面,理应被"打扮"得漂漂亮亮,但往往面目全非、惨不忍睹;虽API只是应用的一个"副产品", 但恰是分歧和混乱的最佳"指示灯"。

为什么绝大部分的API管理平台, 没有实现从API设计一步到位正向工程化到API实现呢? 因为无法做到!!!

平台定位是大一统,就像再好的IDE 也不能帮你设计出NB的软件一样

解决之道在于取舍, 在单个团队里面开发语言和框架基本是一定的,让放弃大一统成就小而美成为可能。

ApiHug 正是在限定范围内,为API正向工程化提供可能;提供专门为API设计的元语,设计 ⇋ 落地,实现双向可逆推导。

如果说现在市面上很多API平台是 “面子”工程, 那么ApiHug 就是您的“里子”工程,提升您的研发核心力量。 

API 设计工具千万家,ApiHug才是真的爱大家

💝 不玩心跳、擦边,只有实打实的爱!

⛔ 不是更强的 postman、jmeter, xxxx!

🥳 ApiHug 提供API 设计到实现的新范式!

ApiHug 准则:

  1. 📐 设计先行:  Design First

  2. 📑 协议驱动:Specification Driven

  3. 🗺️ 单一信任源: Single Source of Truth

  4. ❤️ 开发同理心: Development Empathy

ApiHug:

  1. 无服务: 一切尽在本地, 或者您的内部 Repository

  2. 无强依赖: 遵循行业最佳、最成熟实践、可插拔 

  3. 无隐藏:一切尽公开透明

📐设计先行

通过统一的API 设计元语(DSL, domain specific language), 让API 设计更语言化(Describe);实现高度的一致化,和高复用。

📑协议驱动

OAS (OpenAPI specification), 是 ApiHug世界的 "金科玉律", 严格保证定义 ↔ 实现之间同构(isomorphism)态射。

🗺️单一信任源

实现 API 从:蓝图→施工→测试→落地,不走样, 不变形,不改味。极致沟通效率和极低信任成本。

❤️ 开发同理心

置身于多种角色,感同身受,在快和慢,现在和将来,个体和团队上综合平衡,极具同理心是ApiHug 人文基础,她不仅仅是一段代码,一个工具,一种方式。

We Build What We Love & Love What We Built

https://apihug.com/docs/start/what-is-apihug

开启愉快开发之旅:https://apihug.com/docs/start

00. 预安装

  1. JDK 17+ OpenJDK or Oracle

  2. Gradle 8+

  3. IDEA 2022+

  4. ApiHug - API design Copilot  IDEA plugin 市场

01. 插件安装

  1. File

  2. Settings

  3. Plugin

  4. Search ApiHug

  5. Install & Restart

图片

02. Project Wizard

ApiHug - API design Copilot 提供了一个非常友好的项目启动模板,按照步骤一路点下来就可以。

01- 开始ApiHug项目

  1. File

  2. New -> Project

  3. ApiHug

图片

02-项目设置

  1. Project settings

  2. package

  3. name

  4. description

  5. SDK Settings

  6. version

  7. DB Vendor

  8. Cache

  9. Port

图片

03-Spring 设置

标准Spring 配置和 starter.spring.io 一样:

  1. 选择类型

  2. 选择你需要的模块,比如: Spring Web

图片

最后 点击: Create -> Open Project  就可以打开项目啦!

04-开启项目

跟着IDEA的引导:

  1. 以 Gradle 方式加载项目, 如果没有检查通知Notification栏目,可能你隐藏了;

  2. 两个模块 demo-app-proto & demo-app 应该被gradle自动识别出来。

图片

04.1-Wire
  1. 打开 README.md > 0. Build All

  2. 找到那段脚本贴到控制台上: Terminal

  3. 回车 Enter 执行

  4. 检查模块 demo-app-proto 目录 main > wire 里面内容和更新

图片

04.2-Stub
  1. 打开 README.md > 2. Build Stub (Individual)

  2. 同理找到那段命令行,贴到控制台 Terminal

  3. 按回车 Enter 执行

  4. 检查模块 demo-app 目录 main > stub 里内容和更新:

图片

04.3-Boot
  1. 打开 README.md > 3. Run Application

  2. 找到对于命令,贴到 Terminal

  3. 回车 Enter 执行

  4. 检查命令行输出 Log demo-app

图片

----------------------------------------------------------
Application 'demo-app' is running! Access URLs:
Local                             http://localhost:18089/External                          http://192.168.0.115:18089/OAS                               http://192.168.0.115:18089/v3/api-docsActuator                          http://192.168.0.115:18089/managementApi-Errors                        http://192.168.0.115:18089/hope/meta/errorsApi-Dictionaries                  http://192.168.0.115:18089/hope/meta/dictionariesApi-Authorities                   http://192.168.0.115:18089/hope/meta/authoritiesProfile(s)                        dev
04.4-查看 OAS
  1. 从控制台命令行上找到对应的URL

  2. 在浏览器(Chrome)输出查看即可 

图片

ApiHug 工具栏

ApiHug 工具栏(Tool Window)  默认停靠在您的IDEA右侧栏, 当然您也可通过上面菜单调出 :   ApiHug > ApiHug Designer : 

图片

🥳 恭喜! 开启您愉悦的开发之旅吧!

图片

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/1702862.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

[猫头虎分享21天微信小程序基础入门教程] 第17天:小程序的用户授权与安全

[猫头虎分享21天微信小程序基础入门教程] 第17天:小程序的用户授权与安全 第17天:小程序的用户授权与安全 🔒 自我介绍 大家好,我是猫头虎,一名全栈软件工程师。今天我们继续微信小程序的学习,重点了解如…

OrangePi AIpro 性能测试以及使用体验

OrangePi AIpro 性能测试以及使用体验 1. 介绍 OrangePi AIpro(8T)采用昇腾AI技术路线。 具体为4核64位处理器AI处理器,集成图形处理器,支持8TOPS AI算力拥有8GB/16GB LPDDR4X,可以外接32GB/64GB/128GB/256GB eMMC模块,支持双4…

超详细避坑指南!OrangpiAIPro转换部署模型全流程!

目录 OrangepiPro初体验 前述: 一、硬件准备 二、安装CANN工具链(虚拟机) 三、配置模型转换环境(虚拟机) 1.安装miniconda 。 2.创建环境。 3.安装依赖包 四、转换模型 1. 查看设备号(开发板&…

Linux服务器安装anaconda、配置pytorch环境

Linux服务器安装anaconda并配置pytorch环境 Linux服务器安装anaconda下载anaconda安装anaconda验证是否安装成功注意默认python版本 配置pytorch环境新建虚拟环境安装pytorch Linux服务器安装anaconda 下载anaconda 首先进入anaconda网站,根据自己的需要选择一个版…

LLM中的RoPE位置编码代码解析与RoPE的性质分析(一)

本博客需要对位置编码有一定了解,但不熟悉代码实现的老哥看。 正弦位置编码(sinusoidal) 在介绍RoPE之前,先回顾一下正弦位置编码。 数学表达 P E ( p o s , 2 i ) s i n ( p o s 1000 0 2 i / d m o d e l ) PE(pos, 2i) sin…

5.27作业

定义自己的命名空间my_sapce&#xff0c;在my_sapce中定义string类型的变量s1&#xff0c;再定义一个函数完成对字符串的逆置。 #include <iostream>using namespace std; namespace my_space {string s1;string reverse1(string s1);} using namespace my_space; int m…

Web(数字媒体)期末作业

一.前言 1.本资源为类似于打飞机的网页游戏 2.链接如下&#xff1a;【免费】前端web或者数字媒体的期末作业&#xff08;类似于打飞机的2D网页小游戏&#xff09;资源-CSDN文库 二.介绍文档

HR人才测评,哪些岗位需要测评想象力?

什么是想象力&#xff1f; 想象力是指&#xff0c;人们通过在已有物质的基础上&#xff0c;通过大脑想象、加工、创造出新事物的能力&#xff0c;举一个非常简单的例子&#xff0c;在提到鸟这种生活的时候&#xff0c;大家会联想到各种各样不同鸟的品种。 哪些岗位需要测评…

喜讯 | 聚铭网络入选2024安在新榜网络安全产品“大众点评”百强榜及全景图

近日&#xff0c;安在新榜发布了备受期待的《2024中国网络安全产品用户调查报告》。在这份权威报告中&#xff0c;聚铭网络凭借先进的技术、优秀的产品和专业的配套服务&#xff0c;成功入选《2024安在新榜网络安全产品“大众点评”百强榜》。 报告通过对全国企业用户进行专项调…

海外仓erp系统是什么?和海外仓管理系统一样吗?

为了满足海外仓全球化发展的大趋势&#xff0c;同时提升海外仓运转的效率&#xff0c;一套好用&#xff0c;性价比高的海外仓管理系统还是非常重要的。 不过很多海外仓企业其实不太分得清erp系统和海外仓管理系统的差异&#xff0c;今天我们就来系统的聊一下&#xff0c;方便大…

React useState修改对象

在 React 中&#xff0c;useState 是一个 Hook&#xff0c;它可以让函数组件拥有状态。当想要改变一个对象类型的状态时&#xff0c;我们需要使用展开运算符&#xff08;...&#xff09;或者 Object.assign 来确保状态是正确地更新。 以下是一个使用 useState 来更新对象的例子…

windows下nvm的安装及使用

目录 一、下载二、安装三、使用 一、下载 下载链接&#xff1a;https://github.com/coreybutler/nvm-windows/releases 二、安装 双击 nvm-setup.exe&#xff0c;按提示一步步安装。 三、使用 # 查看已安装的版本信息 nvm list&#xff08;可简写为&#xff1a;nvm ls&am…

计算机视觉中-语义分割

语义分割 语义分割是计算机视觉中的一个关键技术&#xff0c;它涉及对图像中的每个像素进行类别划分&#xff0c;从而识别出图像中的不同物体或区域。具体来说&#xff0c;语义分割就是按照“语义”给图像上目标类别中的每一点打上一个标签&#xff0c;使得不同种类的东西在图像…

【RSGIS数据资源】中国多时期土地利用遥感监测数据集(CNLUCC)

文章目录 数据基本信息摘要数据说明数据引用方式 数据基本信息 数据时间&#xff1a; 多时期(1970年代末期以来11期) 空间位置&#xff1a; 中国 数据格式&#xff1a; 矢量与栅格 空间分辨率&#xff1a; 30m 主题分类&#xff1a; 中国土地利用遥感监测数据 DOI标识&#xf…

Android Gradle plugin 版本和Gradle 版本

1.当看到这两个版本时&#xff0c;确实有点迷糊。但是他们是独立的&#xff0c;没有太大关联。 就是说在Android studio中看到的两个版本信息&#xff0c;并无太大关联&#xff0c;是相互独立的。Gradle插件版本决定了你的项目是如何构建的&#xff0c;而Gradle版本是执行构建…

UML-系统架构师(二)

1、UML&#xff08;Unified Modeling Language&#xff09;是面向对象设计的建设工具&#xff0c;独立于任何具体程序设计语言&#xff0c;以下&#xff08;&#xff09;不属于UML中的模型。 A用例图 B协作图 C活动图 DPAD图 解析&#xff1a; UML一共14种图 结构图&…

电商场景的视频动效

AtomoVideo:AIGC赋能下的电商视频动效生成本文分享阿里妈妈视频 AIGC(AtomoVideo等) 赋能视频广告创意的探索和实践。通过基于扩散模型的视频生成技术,结合可控生成技术,使静态电商图片能够栩栩如生地“动”起来,实现了在电商领域的视频 AIGC 应用落地。https://mp.weixi…

LDRA Testbed(TBrun)软件单元测试_操作指南

系列文章目录 LDRA Testbed软件静态分析_操作指南 LDRA Testbed软件静态分析_自动提取静态分析数据生成文档 LDRA Testbed软件静态分析_Jenkins持续集成_(1)自动进行静态分析的环境搭建 LDRA Testbed软件静态分析_Jenkins持续集成_(2)配置邮件自动发送静态分析结果 LDRA Testb…

星融元获2024网络开源优秀创新成果奖!

5月25日&#xff0c;星融元受邀参加2024年第四届网络开源技术生态大会&#xff0c;分享主题为“开放的网络 开放的AI生态”主题演讲&#xff0c;深受现场用户的认可&#xff1b;《Easy RoCE&#xff1a;基于SONiC、Klish和Prometheus的极简无损网络解决方案》获得2024网络开源优…

网络其他重要协议(DNS、ICMP、NAT)

1.DNS DNS是一整套从域名映射到IP的系统 1.1 DNS背景 TCP/IP中使用IP地址和端口号来确定网络上的一台主机的一个程序&#xff0c;但是IP地址不方便记忆&#xff0c;例如我们想访问百度就会在浏览器中输入baidu.com而不是百度的IP地址。于是人们发明了一种叫主机名的东西, 是…