我如何开始使用 swagger-ui [关闭]

Posted 2023-03-31

【中文标题】我如何开始使用 swagger-ui [关闭]

【英文标题】：How do I get started with swagger-ui [closed]

【发布时间】：2014-11-28 12:21:30

【问题描述】：

什么是swagger-ui，有什么用？

我访问过http://swagger.io/，但我需要更多信息。

请指导我。

【参考方案1】：

Swagger UI 是一个工具，它获取 Swagger 规范文件，直观地呈现它们并允许您执行操作。

Swagger 本身就是一个记录和描述 REST API 的规范。可以在此处找到规范 - https://github.com/swagger-api/swagger-spec/。存储库包含规范本身、json 模式、示例等。存储库的主要 README 还指向其他工具，包括用于生成规范的库和框架。

在创建 Swagger 规范时，您可以使用其中一个框架并将其与现有代码集成以自动生成此类文档。

如果您没有现有的应用程序或希望手动记录它，您可以使用 Swagger-Editor 工具或您选择的文本编辑器。

【讨论】：

我有一个现有的 Swagger API 正在运行。现在，Swagger UI 需要什么才能显示我的 API 文档？只是打开 ./dist/index.html 并导航到我的招摇 api 并不能完全解决它。我必须通过http手动提供swagger.json吗？我的 API 是否需要一个额外的端点来提供 .json 文件？感谢您的澄清。

问题不清楚，缺乏细节。我建议要么在此处开始一个包含完整详细信息的新问题，要么使用我们的 google 小组，该小组受到更密切的监控。

我也很困惑。 swagger UI如何与Swagger编辑器开发的api一起使用？

【参考方案2】：

maven 依赖：

    <dependency>
         <groupId>io.springfox</groupId>
         <artifactId>springfox-swagger2</artifactId>
         <version>2.4.0</version>
    </dependency>  
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.4.0</version>
    </dependency>

================================================ ==============================

@Configuration
@EnableSwagger2   
    public class SwaggerConfig 

        private static final String SEARCH = "spring-rest-swagger";

        @Bean
        public Docket myApp() 
            return new Docket(DocumentationType.SWAGGER_2).groupName(SEARCH)
                    .apiInfo(apiInfo()).tags(new Tag(SEARCH, "spring-rest-swagger API"));
        

        private ApiInfo apiInfo() 
            return new ApiInfoBuilder().title(SEARCH).build();
        
    

================================================ ================================

以下链接供参考使用：（逐步解释）

https://www.youtube.com/watch?v=xeYpiHLpme0&t=1s