我们正在使用 swagger.io 来记录我们的 REST API,一旦它发布在我们的网站文档子页面上,您能否推荐如何使它对最终用户更漂亮?我们想要包含一些模式/图像,我非常喜欢这个文档的结构:https ://developer.xero.com/documentation/api/api-overview 。当然,我们希望它是从代码中自行生成的 + 一些额外的描述将通过所见即所得添加。
非常感谢您的建议,祝您有美好的一天!PS:对不起我的语言,我不是工程师/技术人员:)
我们正在使用 swagger.io 来记录我们的 REST API,一旦它发布在我们的网站文档子页面上,您能否推荐如何使它对最终用户更漂亮?我们想要包含一些模式/图像,我非常喜欢这个文档的结构:https ://developer.xero.com/documentation/api/api-overview 。当然,我们希望它是从代码中自行生成的 + 一些额外的描述将通过所见即所得添加。
非常感谢您的建议,祝您有美好的一天!PS:对不起我的语言,我不是工程师/技术人员:)
我使用 XeroAPI - 链接的文档实际上是在发布过程中直接从我们的 OpenAPI 规范生成的。
我们还使用 OAS (OpenAPISpec) 自动生成 SDK 文档,其中显示了我们支持的每种语言 SDK 的特定代码示例。
https://xeroapi.github.io/xero-node/accounting/index.html
您可以从 openapi-generator 存储库中阅读有关文档生成的更多信息,并对 HtmlDocs2 进行一些研究。