Getting Started

English | 简体中文

Full Demo

1. show how the apihug work
2. how development model

The libs of this project will be published to :

💝 SDK Version: ， 注意 Apihug 采用整包发行， Gradle plugin + 基础包公用一个版本。

💝 IDEA Plugin: ApiHug - API design Copilot    Plugin Handbook    Plugin FAQ   

😆 Guide：

1. ApiHug101-Bilibili
2. ApiHug101 Youtube

Quick Build

0. Build All

#windows
./gradlew.bat clean build -x test -x wireTest -x stubTest

#others
sh gradlew clean build -x test -x wireTest -x stubTest

1. Build Wire (Individual Optional)

#windows
./gradlew.bat demo-order-proto:clean wire build -x test -x wireTest

#others
sh gradlew demo-order-proto:clean wire build -x test -x wireTest

2. Build Stub (Individual)

Everytime you update application's dependence proto libraries, please run this command to re-generate your stubs.

#windows
./gradlew.bat demo-user:clean stub build -x test -x stubTest

#others
sh gradlew demo-order:clean stub build -x test -x stubTest

3. Run Application

#windows
./gradlew.bat demo-order:bootRun

#others
sh gradlew demo-order:bootRun

👍Then just kick off the application, in logger output you will find:

Application 'demo-order' is running! Access URLs:

	Local                             http://localhost:18189/                                         
	External                          http://192.168.0.1:18189/                                        
	OAS                               http://192.168.0.1:18189/v3/api-docs                             
	Actuator                          http://192.168.0.1:18189/management                              
	Profile(s)                        dev    

🥳 Congratulations! You have successfully started your application!

Reference Documentation

For further reference, please consider the following sections:

1. Apihug.com Github
2. Apihug Wire Plugin
3. Apihug Stub Plugin
4. Apihug Trivial
5. Apihug FAQ
6. Official Gradle documentation
7. Spring Boot Gradle Plugin Reference Guide
8. ApiHug - API design Copilot IDEA Plugin
9. ApiHug - IDEA FAQ
10. ApiHug - IDEA Handbook