如何在不影响实际API的情况下最大程度地促进API文档文本的编辑

时间:2018-07-30 08:54:07

标签: content-management-system documentation-generation

我们的API文档由OAS完成,并使用Swagger UI。

在大多数情况下都很好,但是有些冗长的介绍文本元素和背景文本让人觉得笨拙,与广为人知的API示例不符。

是否有一种很好的方法允许技术作家编辑这些纯文本部分,而不允许他们访问其余代码?

请求是允许技术作者随时间编辑文本,而不需要持续的开发时间来更新整个API。 某种轻量级CMS?

0 个答案:

没有答案