SwaggerHub 中使用 XML 注释的 API 文档

发布于 2025-01-12 10:03:43 字数 223 浏览 2 评论 0原文

我正在尝试更新 REST API 的 API 文档。

目前,我有 C# Asp.net Web API 代码和 Swashbuckle.AspNetCore。 我正在使用 Visual Studio 在 C# 中编辑和添加 XML 注释来更新 API 文档。

有没有办法使用 SwaggerHub 或其他一些允许我使用 Markdown 的工具来做到这一点。

我在网上没有找到任何解决方案。

I am trying to update API documentation for REST APIs.

Currently, I have a C# Asp.net Web API code and Swashbuckle.AspNetCore.
I am editing and adding XML comments in C# using Visual Studio to update the API documentation.

Is there a way I can do this using SwaggerHub or some other tool that lets me use Markdown.

I have not found any solutions for this online.

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(1

你的他你的她 2025-01-19 10:03:43

SwaggerHub 编辑器支持使用 Markdown 语法进行注释以进行文本格式化。

我建议查看 SwaggerHubs 注释文档以获取更多信息。 https://support.smartbear.com/swaggerhub/docs/collaboration/comments。 html

The SwaggerHub editor supports comments with Markdown syntax for text formatting.

I would suggest checking out SwaggerHubs documentation on Comments for more information. https://support.smartbear.com/swaggerhub/docs/collaboration/comments.html

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文