Swagger
目前产品的前后端接口文档是Go后端通过Swag来生成Swagger 2.0 Api文档,然后在 Swagger UI 界面中调试。
但Swagger UI一直以来的诟病就是界面不美观,没有标签栏等,界面不够现代化,不易用。
Scalar
最开始发现Scalar是在微软的 .NET 9的相关资讯中看到的,Swagger被移除了,Scalar是微软官方推荐的Swagger替代品。
相比于使用ApiFox、ApiPost之类的国产API接口管理工具,优点是WEB端不需要安装软件注册账号。
只需要搭建一个虚拟局域网就能解决外部网络访问的问题。
具体的介绍和界面Github中都有,目前我已经在公司里用 Scalar 全面替代 Swagger UI 了。
使用方式很简单,只需要一个HTML页面,导入Swagger/OpenAPI 2.0 Api文档就能加载,完全能够替代Swagger UI界面。
还能生成多种语言的接口调用代码,方便后续调试。
<!DOCTYPE html>
<html>
<head>
<title>%s</title>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<body>
<script id="api-reference" data-url="%s"></script>
<script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>
</body>
</html>
