简体   繁体   English

Swagger/OpenAPI 将文档放在哪里?

[英]Where does Swagger/OpenAPI place documentation?

I just downloaded a Swagger/OpenAPI generated SDK.我刚刚下载了一个 Swagger/OpenAPI 生成的 SDK。 I know that API documentation should have been autogenerated by Swagger itself... however I am looking through the file directory and don't see anything.我知道 API 文档应该是由 Swagger 本身自动生成的......但是我正在查看文件目录并没有看到任何内容。 I have tried searching on this topic for a few hours now and nothing has been very helpful.我已经尝试在这个主题上搜索几个小时了,但没有任何帮助。 Any help is appreciated.任何帮助表示赞赏。

OpenAPI is a standard of defining an API, it is not itself a tool that generates SDKs or documentation. OpenAPI 是定义 API 的标准,它本身并不是生成 SDK 或文档的工具。

You likely used openapi-generator or a similar tool to generate your SDK - documentation would need to be generated from another tool, such as ReDoc or something from SmartBear (the original authors of Swagger).您可能使用openapi-generator或类似工具来生成 SDK - 需要从其他工具生成文档,例如ReDocSmartBear (Swagger 的原始作者)的工具。

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM