基本介绍
了解OpenAPI
这个东东的小伙伴应该都知道,OpenAPI
只是通用的接口定义规范,而展示的接口文档UI是可以随便替换的,并且这种UI界面以及平台还特别多!使用过GoFrame Server
来切换接口文档UI页面,或者将接口文档对接到第三方接口文档平台 - 非常简单!
使用示例
咱们通过代码来展示一下,如果快速地将接口文档UI切换为。SwaggerUI
的相关链接:
我们这里只定义了一个Hello
的接口。可以看到,我们通过一个接口来展示SwaggerUI
的HTML
页面,并且将OpenAPI
的接口文件路径定义为/api.json
,没有启用Server
自带的UI页面。执行后,终端输出:
2022-05-18 20:41:09.160 [INFO] openapi specification is serving at address: http://127.0.0.1:8199/api.json
ADDRESS | METHOD | ROUTE | HANDLER | MIDDLEWARE
----------|--------|-----------|-----------------------------------------------------------------|--------------------
:8199 | ALL | /* | github.com/gogf/gf/v2/net/ghttp.internalMiddlewareServerTracing | GLOBAL MIDDLEWARE
:8199 | ALL | /api.json | github.com/gogf/gf/v2/net/ghttp.(*Server).openapiSpec |
----------|--------|-----------|-----------------------------------------------------------------|--------------------
:8199 | GET | /hello | main.(*Hello).Say |
----------|--------|-----------|-----------------------------------------------------------------|--------------------
戳此链接访问:http://127.0.0.1:8199/swagger/
开发者自定义其他的接口文档UI类似如此。