SpringMVC整合Swagger

最新推荐文章于 2024-08-07 04:16:44 发布

雪_糕

最新推荐文章于 2024-08-07 04:16:44 发布

阅读量395

点赞数

分类专栏： Swagger Spring 文章标签： swagger2

本文链接：https://blog.csdn.net/u014792352/article/details/68951761

版权

Spring 同时被 2 个专栏收录

2 篇文章 0 订阅

订阅专栏

Swagger

1 篇文章 0 订阅

订阅专栏

1:Swagger介绍

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统

作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。Swagger 让部署

管理和使用功能强大的API从未如此简单。

2：SpringMvc整合Swagger

2.1加载Swagger相关jar

             <dependency>
		   <groupId>com.mangofactory</groupId>
		   <artifactId>swagger-springmvc</artifactId>
	    </dependency>
            <dependency>
                  <groupId>com.google.guava</groupId>
                  <artifactId>guava</artifactId>
           </dependency>

2.2前台配置

我们需要下载swagger的相关页面文件，https://github.com/swagger-api/swagger-ui 下载后把dist内容拷贝到项目中

2.3：springmvc文件中配置

2.4：配置上图中的com.mutualaid.swagger 中的swagger2文件

package com.mutualaid.swagger;

import com.mangofactory.swagger.configuration.SpringSwaggerConfig;
import com.mangofactory.swagger.models.dto.ApiInfo;
import com.mangofactory.swagger.plugin.EnableSwagger;
import com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;

/**
 * 
 * <p>Title:</p>
 * <p>Description:</p>
 * @author Mr.Cheng
 * @date 2017年2月18日 下午1:32:52
 */
@Configuration
@EnableSwagger
@EnableWebMvc
public class SwaggerConfig {

    private SpringSwaggerConfig springSwaggerConfig;

    /**
     * Required to autowire SpringSwaggerConfig
     */
    @Autowired
    public void setSpringSwaggerConfig(SpringSwaggerConfig springSwaggerConfig)
    {
        this.springSwaggerConfig = springSwaggerConfig;
    }

    /**
     * Every SwaggerSpringMvcPlugin bean is picked up by the swagger-mvc
     * framework - allowing for multiple swagger groups i.e. same code base
     * multiple swagger resource listings.
     */
    @Bean
    public SwaggerSpringMvcPlugin customImplementation()
    {
        return new SwaggerSpringMvcPlugin(this.springSwaggerConfig)
                .apiInfo(apiInfo())
                .includePatterns(".*");
    }

    private ApiInfo apiInfo()
    {
        ApiInfo apiInfo = new ApiInfo(
                "Contexts",
                "notes",
                "开发者: Mr.Cheng",
                "1234567@qq.com",
                "MIT License",
                "/LICENSE");
        return apiInfo;
    }
}