Skip to main content

接口文档

用规范路由的写法，GoFrame会自动生成接口文档。所有接口信息会自动生成在/api.json中，遵循的是OpenAPIv3标准，框架默认使用的是redoc来生成文档前端页面，只能查看接口信息，不能进行请求测试。因此可以可以改为其他UI页面，例如swaggerUI或者自行实现UI页面。

  • 注释掉manifest/config/config.yml中的swaggerPath: "/swagger"
  • 实现UI页面，引入swaggerUI组件

swagger.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <link rel="stylesheet" href="/swagger-ui.css">
    <script src="/swagger-ui-bundle.js"></script>
    <title>API Doc</title>
</head>
<body>
    <div id="swagger-ui"></div>
</body>
</html>

<script type="text/javascript">
    window.ui = SwaggerUIBundle({
        url: '/api.json',
        dom_id: '#swagger-ui'
    })
</script>

引入的CSS与JS文件如果下载到项目中则用上述方式引入，或者可以通过下列CDN引入

<link rel="stylesheet" href="https://unpkg.com/swagger-ui-dist@latest/swagger-ui.css" />

  • 添加路由
group.GET("/swagger", func(req *ghttp.Request) {
                    req.Response.WriteTpl("/swagger.html")
                })