Getting Started
如何在15分钟内,使用 ApiHug 启动一个API开发项目.
如何在15分钟内,使用 ApiHug 启动一个API开发项目。
ApiHug
ApiHug - API design Copilot 提供了一个十分友好且直观的项目模板,可以帮助你快速启动API开发。它会循序渐进地指导你创建符合最佳实践的API项目。
Spring 配置,等同 Start Spring 习惯:
Spring Web
最后点击 Create -> Open Project 打开项目。
SDK 版本随着时间的推延在不断升级;记得检查maven库里版本:
对于已存在项目, 你可以手动升级:
apihug = "0.9.2-RELEASE"
更新到最新版本;根据 IDEA 的引导导入项目:
Gradle
方式加载项目, 如未提示,请手动检查并且导入(如果你隐藏了IDEA的通知弹窗)demo-app-proto
& demo-app
应该被Gradle
正常识别和加载进来一个最简单的项目模块如下 (simplest-demo):
+---gradle
| | libs.versions.toml (1)
+---demo-app (2)
| | build.gradle
| \---src
| \---main
| +---java
| | \---com
| | \---apihug
| | \---demo
| | | DemoAppApplication.java
| | +---domain
| | \---service
| \---resources
| | hope-stub.json (3)
|
+---demo-app-proto (4)
| | build.gradle
| \---src
| \---main
| +---proto
| | \---com
| | \---apihug
| | \---demo
| | \---proto
| | +---api
| | \---infra
| \---resources
| hope-wire.json (5)
File | Comment |
---|---|
(1) libs.versions.toml | 版本 toml 配置文件 |
(2) demo-app | Application 模块 |
(3) hope-stub.json | Application 模块配置 |
(4) demo-app-proto | Protocol 模块 |
(5) hope-wire.json | Protocol 模块配置 |
# libraries
apihug = "0.9.9-RELEASE"
# plugins
springBoot = "3.2.5"
springDependency = "1.1.4"
#Apihug Common
apihugBom = { group = "com.apihug", name = "it-bom", version.ref = "apihug" }
#Spring plugin
springBoot = { id = "org.springframework.boot", version.ref = "springBoot" }
springDependency = { id = "io.spring.dependency-management", version.ref = "springDependency" }
Proto 模块的 Wire 命令负责对协议 protocol buffers 文件进行校验和编译。
README.md
> 0. Build All
;Terminal
, 例子: gradlew clean build -x test -x wireTest -x stubTest
;Enter
执行demo-app-proto
路径 main > wire
下的更新;Application 模块的 Stub 命令负责从协议模块中的API定义生成stub代码结构。
README.md
> 2. Build Stub (Individual)
Terminal
, 例子: gradlew.bat demo-app:clean stub build -x test -x stubTest
;Enter
执行demo-app
路径 main > stub
下的更新;README.md
> 3. Run Application
;Terminal
, 例子: gradlew demo-app:bootRun
;Enter
执行;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-docs
Actuator http://192.168.0.115:18089/management
Api-Errors http://192.168.0.115:18089/hope/meta/errors
Api-Dictionaries http://192.168.0.115:18089/hope/meta/dictionaries
Api-Authorities http://192.168.0.115:18089/hope/meta/authorities
Profile(s) dev
/v3/api-docs
copy 出来;ApiHug 工具窗口 应该停靠在IDE的右侧,如果没有,你也可以从顶部菜单栏打开它: ApiHug > ApiHug Designer
:
🥳 太棒了!你已经成功完成了一个完美的API开发项目!
在之前的15分钟演示中,我们介绍了API设计和开发涉及的典型步骤。这些步骤通常包括各种琐碎的任务,使我们难以集中精力于核心业务逻辑设计。但是使用ApiHug,您可以摆脱所有繁琐和麻烦的步骤。
ApiHug自动化了这些任务,并生成高质量的设计,其结构和代码细节都非常友好易懂。在接下来的课程中,我们将深入探讨ApiHug的功能。
事实上,ApiHug使用的技术并非完全是新发明。平台如Jhipster, Spring Starter,Grails和Ruby on Rails最为先驱者,已经经历了大量的探索和工程实践。
ApiHug在这些先驱平台的最佳实践和经验教训的基础上进行了构建,使其更加实用和简单易用。我们感谢这些平台为ApiHug奠定了基础做出的贡献。