编程语言
gRPC 搭配 Swagger 实现微服务文档化
本文探讨了程序员对文档编写的矛盾态度,以及在微服务架构中接口文档的重要性。介绍了使用 protoc-gen-doc 方案生成 Protobuf 格式的 gRPC 服务文档,并提供了 Docker 部署示例。另外,还介绍了整合 Swagger 的方案,通过 GrpcSwaggerProvider 来实现 gRPC 与 Swagger 的结合,使得查阅和调试 gRPC 接口更加便捷。最后,作者分享了对服务治理中接口文档重要性的思考,并总结了两种针对 gRPC 的服务文档化方案的优缺点。
编程语言
通过 ApiExplorer 为 Swagger 提供 MVC 扩展
文章讲述了作者因为 Jekins 项目模板不支持多项目解决方案而妥协使用混合技术栈的单一项目,并在项目中引入 Swagger 生成 API 文档。作者介绍了 Swagger 生成文档的核心依赖 IApiExplorer 接口,并针对 ASP.NET MVC 项目缺乏对 Swagger 的支持,创建了一个自定义的 MvcApiExplorer 类来扩展 Swagger 的功能。通过反射和自定义实现,使得 Swagger 能够识别 MVC 项目中的控制器和动作,并生成相应的 API 文档。作者还提供了相关的代码示例,并在 GitHub 上发布了扩展的代码和示例项目,方便读者学习和使用。1