【新】ApiHug官方文档-ApiHug Spring API 扩展-5/10

参考

2. ApiHug Spring API Extension
3. ApiHug快速开启
4. # ApiHug - API design Copilot-IDEA

Api

API资源信息暴露：

1. swagger 文档 /v3/api-docs
2. api meta 信息 /hope/meta/errors|dictionaries|authorities

API 环境配置：

1. hope.open.api.path 配置文档目录， 默认 /v3/api-docs
2. hope.open.api.enable 是否暴露 swagger 文档信息， 建议在生产环境关闭
3. hope.open.api.showMeta 是否暴露 API meta 信息， 建议在生产环境关闭

项目启动后，查看命令行，可得到类似信息：

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

所有这些 资源 元信息都是由 wire 模块生成，非运行时代码反射扫描所得；

API和API元信息均在设计阶段已经固定，运行时不能修改！

如需要修改，需要重新 编译&发布 你的 wire 模块，也就是API定义模块！

建议在生产环境关闭此类信息接口的暴露

​详细信息

资源	说明
/v3/api-docs	标准OAS(Swagger2.0)文档
/hope/meta/errors	错误码列表
/hope/meta/dictionaries	字典(常量)列表
/hope/meta/authorities	权限列表

ApiSmart

ApiSmart 是ApiHug 插件内置 AI 支持功能； ApiSmart 作为一个入门AI智能编码，和本地AI 学习调试工具， 做到 练学习操 一体；

一边练习，一边增加你对AI 体验， 一边提升你的工作效率， 一箭三雕。

1. 精准携上下文， 代码片段位置
2. 识别语言， 当然IDEA内非常简单
3. 精炼的prompt， 当然你也可以覆盖他

# ApiHug - API design Copilot

ApiHug 的 ApiSmart 利用 Langchain4j 与大型语言模型（LLM）供应商进行通信；因此基本上任何 Langchain4j 支持的供应商都可以被 ApiSmart 支持；

apihug.com/zhCN-docs/c…