瞧瞧人家写的API, 那叫一个优雅真是服气了!

最新推荐文章于 2024-11-04 20:33:37 发布

ApiHug

最新推荐文章于 2024-11-04 20:33:37 发布

阅读量558

点赞数 16

分类专栏： ApiHug 文章标签： java ApiHug intellij-idea spring

本文链接：https://blog.csdn.net/AK15221736052/article/details/139106667

版权

ApiHug 专栏收录该内容

43 篇文章 0 订阅

订阅专栏

做好事难,一辈子做好事更难，写一个漂亮的接口容易，难的是一直写漂亮的接口，当持之以恒变成一种习惯，再而卓越！

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

💝 不玩心跳、擦边，只有实打实的爱！

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

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

ApiHug 准则：

📐 设计先行： Design First
📑 协议驱动：Specification Driven
🗺️ 单一信任源: Single Source of Truth
❤️ 开发同理心: Development Empathy

ApiHug:

无服务: 一切尽在本地，或者您的内部 Repository
无强依赖: 遵循行业最佳、最成熟实践、可插拔
无隐藏：一切尽公开透明

📐设计先行

通过统一的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. 预安装

JDK 17+ OpenJDK or Oracle
Gradle 8+
IDEA 2022+
ApiHug - API design Copilot IDEA plugin 市场

01. 插件安装

File
Settings
Plugin
Search ApiHug
Install & Restart

02. Project Wizard

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

01- 开始ApiHug项目

File
New -> Project
ApiHug

02-项目设置

Project settings
package
name
description
SDK Settings
version
DB Vendor
Cache
Port

03-Spring 设置

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

选择类型
选择你需要的模块，比如： Spring Web

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

04-开启项目

跟着IDEA的引导:

以 Gradle 方式加载项目, 如果没有检查通知Notification栏目,可能你隐藏了;
两个模块 demo-app-proto & demo-app 应该被gradle自动识别出来。

04.1-Wire

打开 README.md > 0. Build All
找到那段脚本贴到控制台上： Terminal
回车 Enter 执行
检查模块 demo-app-proto 目录 main > wire 里面内容和更新

04.2-Stub

打开 README.md > 2. Build Stub (Individual)
同理找到那段命令行，贴到控制台 Terminal
按回车 Enter 执行
检查模块 demo-app 目录 main > stub 里内容和更新:

04.3-Boot

打开 README.md > 3. Run Application
找到对于命令，贴到 Terminal
回车 Enter 执行
检查命令行输出 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