如果我理解你的问题正确地说，你的问题是你有很难阅读/理解的API文档，而且缺乏细节，但你想将它转换成更友好的用户格式，以帮助开发人员自助吗？



我建议查看一些这些API文档工具。其中一些可能有陡峭的学习曲线，但一旦你习惯了它们，它们将使你的API易于使用。



有关这些工具的注意事项，你可以把口红放在猪身上，但它仍然是一头猪。这意味着，如果您不向这些API提供内容以使其更清晰，那么您只需交换一份不清楚/不适合开发人员的API文档，以获取另一个不清楚/不适合开发人员的API文档。



Swagger - 世界上最受欢迎的API框架。 [ ^ ]



API蓝图| API蓝图 [ ^ ]



GitHub - lord / slate：API的漂亮静态文档 [ ^ ]

If i am understanding your question correctly, your issue is that you've got API documentation that is hard to read/understand and is lacking in detail but you want to convert it into a more user friendly format that helps developers help themselves?

I would suggest looking at some of these API documentation tools. Some of them may have steep learning curves, but once you get use to them they will make your API's easy to use.

One thing to note about these tools, you can put lipstick on a pig but it is still a pig. Meaning, if you don't provide the content to these API's to make them more clear, your just trading one unclear/not developer friendly API document for another unclear/not developer friendly API document.

Swagger – The World's Most Popular Framework for APIs.[^]

API Blueprint | API Blueprint[^]

GitHub - lord/slate: Beautiful static documentation for your API[^]