1

我们为项目内部使用设置了一个 Web API。我正在寻找一种记录我们 API 的好方法。我已经在网上搜索并找到了

这些工具读取可以自动创建的 JSON 文件，例如用于 Java。我们的 API 已经增长，我喜欢手动创建 JSON，而不是在文本编辑器中手动创建。是否有工具或前端可以减轻手动创建描述性 JSON 的负担？

另一方面，对于 Web API 的文档，有哪些值得推荐的工具？

4

1 回答 1

0

我在 .NET (C#) 商店工作，我们使用 swagger 来记录我们的 api。我们找不到任何工具来满足您的要求……所以我们只是创建了自己的工具。我认为 swagger 还不够成熟，无法产生这样的公用事业项目……但是。

创建类来表示 swagger 文档描述的 json 对象并不难。我们只需获取这些实例化的类并通过 JSON 序列化程序运行它们，以获取描述端点的单独 json 文件。

祝你好运！

于 2012-07-22T03:20:37.883 回答