所有文章 > 当前标签:Swagger
Golang | Web开发之Gin使用swag生成项目的Swagger API接口文档
2024/11/25
本文介绍了如何在Golang的Web框架Gin中集成Swagger工具,以自动化生成RESTful API文档。首先,提供了Swagger的简单介绍和官网资源链接,然后详细讲解了安装swag和gin-swagger项目的方法,包括使用go install命令和手动编译。接着,文章阐述了在Gin项目中添加Swagger注释、生成swagger.json和swagger.yaml文件的步骤,并展示了如何在控制器中使用Swagger注释定义API文档。最后,通过一个实际的Go-Gin项目案例,演示了如何将Swagger集成到项目中,并提供了访问生成的Swagger UI界面的步骤。通过这些步骤,开发者可以方便地为Gin框架下的API生成文档,并进行接口测试。
如何实现 OpenAPI 多语言 SDK 开发?
【API开发】
通过 Darabonba 对 OpenAPI 进行描述,其本质就是统一了元数据,只是这个元数据并不是 JSON 或者 Yaml 这样的方式来描述的,而是通过 DSL 代码来描述。Darabonba 的编译器则会将 Darabonba 的 DSL 代码转化为 AST,通过 OpenAPI 描述转化而来的 AST 不仅包含了 OpenAPI 的信息,而且还包含整个 OpenAPI 的流程性描述,所以我们只需要通过 AST 开发对应的各语言SDK就可以生成多语言的 SDK了。
2024/11/19
Swagger实用手册:免费创建API文档的方法
【API开发工具】
Swagger 的出现,为解决传统 API 文档管理中的诸多问题提供了创新的方案,并成为当前行业中最为流行的 API 文档工具之一。
2024/11/08
Swagger入门:掌握API文档生成的免费工具
【API开发工具】
Swagger 提供了直观、交互式的文档界面,使得开发者能够轻松编写、测试和维护 API 文档,提升了团队的协作效率和项目的可维护性。
2024/10/18