在项目中使用swagger

最新推荐文章于 2025-11-28 20:22:00 发布

原创最新推荐文章于 2025-11-28 20:22:00 发布 · 3.5k 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#swagger

辅助性配置专栏收录该内容

7 篇文章

订阅专栏

本文详细介绍如何在项目中集成并使用Swagger来管理和测试API接口。包括Swagger的安装配置、依赖引入、配置类编写、控制器层使用及UI文件引入等步骤。

在项目中使用swagger便于管理接口，方便测试

首先在web.xml中初始化载入

<context-param>
    <param-name>webAppRootKey</param-name>
    <param-value>apidoc.root</param-value>
  </context-param>

2在pom.xml导入相应的jar包

<dependency>
          <groupId>com.mangofactory</groupId>
          <artifactId>swagger-springmvc</artifactId>
          <version>0.9.5</version>
      </dependency>

3 在spring-swagger.xml文件中配置

 <bean class="com.baozun.common.MySwaggerConfig" />

对应的配置类：


@Configuration
@EnableWebMvc//如果没加这个会报错
@EnableSwagger//上面三个注释都是必要的，无添加便会出现莫名奇妙的错误
//@ComponentScan(basePackages="com.baozun.web")//添加这个注释，会自动扫描该类中的每一个方法自动生成api文档，就是controller层
public class MySwaggerConfig {
    private SpringSwaggerConfig springSwaggerConfig;


    @Autowired
    public void setSpringSwaggerConfig(SpringSwaggerConfig springSwaggerConfig)
    {
        this.springSwaggerConfig = springSwaggerConfig;
    }


    @Bean
    public SwaggerSpringMvcPlugin customImplementation()
    {
        return new SwaggerSpringMvcPlugin(this.springSwaggerConfig).apiInfo(apiInfo()).includePatterns(
                ".*?");
    }

    private ApiInfo apiInfo()
    {
        ApiInfo apiInfo = new ApiInfo(
                "ehr系统API接口管理",
                "各个controller下对应相应业务接口",
                "My Apps API terms of service",
                "任何问题可联系baozun.com",
                null,
                null);
        return apiInfo;
    }
}

4 在controller层使用swagger

@Controller
@RequestMapping("login")
@Api(description="登录模块", value = "注册版块")//添加注释
public class LoginController  {

 @ResponseBody
    @ApiOperation(value = "登录系统", httpMethod = "POST",response = ResponseMessage.class, notes = "logout")
    public ResponseMessage doLogin(  @ApiParam(value="用户账户和密码",name="TbUser")

}