gpt4 book ai didi

rest - 为 Swagger 写一个 api-doc

转载 作者:行者123 更新时间:2023-12-01 11:36:35 24 4
gpt4 key购买 nike

我正在尝试使用 Swagger UI,它说我应该首先编写一个描述 REST api 的确切 api 的 api-doc。问题是我不知道这意味着什么。这份文件是用简单的英语写的吗?或者是否有某种格式能够生成 UI?

谢谢!

最佳答案

Swagger 是描述 REST API 的规范。可以在此处找到规范文档 - https://github.com/swagger-api/swagger-spec .

通常,有两种方法可以记录您的 API。如果您已有带有代码的现有 API,则可以使用任何现有库 (https://github.com/swagger-api/swagger-spec#additional-libraries) 将其集成到您的代码中并在运行时生成文档。其中一些图书馆还提供离线生成此类文档的功能。

如果您想要设计一个 API,或者不想将另一个库集成到您的应用程序中,您可以使用 https://github.com/swagger-api/swagger-editor本地版本或在线版本 - http://editor.swagger.io .

获得文档后,您可以使用 Swagger UI 对其进行可视化和测试。

关于rest - 为 Swagger 写一个 api-doc,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/26515473/

24 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com