Question

什么是swagger-ui以及它的用途是什么？

开始使用swagger-ui有什么好的资源吗？任何好的教程，博客或书籍？

我也请http://swagger.io/但我需要更多信息。

请指导我。谢谢你

Answer 1

Swagger UI是一个采用Swagger规范文件的工具，可视化地呈现它们并允许您执行操作。

Swagger本身是一个记录和描述REST API的规范。规范可以在这里找到 - https://github.com/swagger-api/swagger-spec/。存储库包含规范本身，json模式，样本等。存储库的主要自述文件还指出了其他工具，包括用于生成规范的库和框架。

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

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

Answer 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

我如何开始使用swagger-ui

2 个答案: