路由注册-规范路由

基本介绍

从 v2.0 版本开始，框架的 Server 组件额外提供了规范化的路由注册方式，更加适合团队规范化的使用场景、业务复杂度更高的项目。规范路由实现了以下特性：

  • 规范化 API 按照结构化编程设计
  • 规范化 API 接口方法参数风格定义
  • 更加简化的路由注册与维护
  • 统一接口返回数据格式设计
  • 保障代码与接口文档同步维护
  • 自动的 API 参数对象化接收与校验
  • 自动生成基于标准 OpenAPIv3 协议的接口文档
  • 自动生成 SwaggerUI 页面

路由注册-规范路由 - 图1 提示

注意一下哦： 规范路由 与原有的 函数、对象、分组 路由方式都是框架的 HTTP Server 组件并存支持的路由注册方式，是为了解决一些规范化和自动化管理接口的场景，更适用于团队多人协作使用。其他的路由方式，特别是框架 v1 版本的函数、对象注册方式也是在新版本支持的哈！看个人使用习惯进行合理选择哟。

相关文档

📄️ 规范路由-基本示例使用GoFrame框架设置和运行一个简单的Hello服务示例，重点展示了配置文件的使用、路由定义和SwaggerUI页面的自动生成。此外，还探讨了接口文档生成、返回中间件处理以及如何定义规范化接口路径等问题，为开发者提供了一种便捷的方法来生成和测试API。

📄️ 规范路由-如何使用在GoFrame框架下定义路由方法、管理和注册路由，以及请求对象和返回对象的规范化结构。通过使用分组路由的Bind方法和基本的BindHandler方法，我们可以有效地管理路由。还包括如何进行输入数据校验以及使用统一的后置中间件进行数据处理。

📄️ 规范路由-常见问题在使用GoFrame框架的规范路由下，如何支持同一接口的多种HTTP Method提交方式。在设计RESTful接口时，每个API应有明确的HTTP Method对应，如创建用户、获取用户列表等。如果需要一个接口支持多个HTTP Method，可以通过Meta标签设置。此外，介绍如何使用类型别名让Response结构体的Data字段返回数组形式。