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

ApiHug Spring API Extension - ApiHugApiHug SDK spring API 扩展https://apihug.com/zhCN-docs/framework/spring-api快速开启 - ApiHug如何在15分钟内，使用 ApiHug 启动一个API开发项目.https://apihug.com/zhCN-docs/startApiHug - API design Copilot - IntelliJ IDEs Plugin | Marketplacehttps://plugins.jetbrains.com/plugin/23534-apihug--api-design-copilot

ApiHug SDK spring API 扩展

​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	权限列表