golang restful 框架之 go-swagger

最新推荐文章于 2024-08-10 07:15:48 发布

hatlonely

最新推荐文章于 2024-08-10 07:15:48 发布

阅读量7.1k

点赞数 2

文章标签： golang swagger restful go-swagger 微服务

本文链接：https://blog.csdn.net/hatlonely/article/details/79294776

版权

本文介绍了如何使用 go-swagger 工具在 Golang 中构建 RESTful API。通过定义 Swagger YAML 文件，可以自动生成框架代码，并提供接口可视化，简化接口管理和维护。示例展示了从编写 API 定义文件到实现业务逻辑的过程，以及如何进行统一处理，如跨域配置。

摘要由CSDN通过智能技术生成

restful 是这些年的高频词汇了，各大互联网公司也都纷纷推出了自己的 restful api，其实 restful 和 thrift，grpc 类似，就是一种协议，但是这种协议有点特殊的就是使用 http 接口，返回的对象一般是 json 格式，这样有个好处，就是可以供前端的 js 直接调用，使用非常方便，但 http 本身并不是一个高效的协议，后端的内部通信还是使用 grpc 或者 thrift 可以获得更高的性能

其实如果只是要用 http 返回 json 本身并不是一件很难的事情，不用任何框架，golang 本身也能很方便做到，但是当你有很多 api 的时候，这些 api 的维护和管理就会变得很复杂，你自己都无法记住这些 api 应该填什么参数，返回什么，当然你可以花很多时间去维护一份接口文档，这样不仅耗时而且很难保证文档的即时性，准确性以及一致性

swagger 有一整套规范来定义一个接口文件，类似于 thrift 和 proto 文件，定义了服务的请求内容和返回内容，同样也有工具可以生成各种不同语言的框架代码，在 golang 里面我们使用 go-swagger 这个工具，这个工具还提供了额外的功能，可以可视化显示这个接口，方便阅读

下面通过一个例子来简单介绍一下这个框架的使用，还是之前的点赞评论系统：https://github.com/hatlonely/microservices

go-swagger 使用方法

api 定义文件

首先需要写一个 api 定义文件，这里我只展示其中一个接口 countlike，请求中带有某篇文章，返回点赞的次数

paths:
  /countlike:
    get:
      tags:
        - like
      summary: 有多少赞
      description: ''
      operationId: countLike
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: title
          in: query
          description: 文章标题