java之swagger使用接口api

最新推荐文章于 2024-08-19 00:15:00 发布

冬子一定要努力

最新推荐文章于 2024-08-19 00:15:00 发布

阅读量4.8k

点赞数

分类专栏：工作笔记

本文链接：https://blog.csdn.net/qq_39809613/article/details/91324701

版权

本文介绍了在SSM框架下使用Swagger进行接口API的配置和使用。首先，需要在pom.xml引入Swagger的相关依赖，并注意Spring版本的兼容性问题。接着，配置Swagger的基本信息，创建ApiConfig.java类。然后，在spring-servlet.xml中配置静态资源访问。通过在Controller中添加Swagger注解来定义接口。最后，可以通过Swagger UI测试接口的连通性和参数传递，确保接口的正常工作。

摘要由CSDN通过智能技术生成

swagger 配置简介

我们的项目时ssm框架。我是在我们web项目测试的：

1.pom 引用

<dependency>

<groupId>com.fasterxml.jackson.core</groupId>

<artifactId>jackson-databind</artifactId>

<version>2.9.5</version>

</dependency>

<!-- swagger2核心依赖 -->

<dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-swagger2</artifactId>

<version>2.6.1</version>

</dependency>

<!-- swagger-ui为项目提供api展示及测试的界面 -->

<dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-swagger-ui</artifactId>

<version>2.6.1</version>

</dependency>

经过测试，2.9.2的swagger , spring 4.0.6使用不了，需要进行升级（spring4.3.17可用）。

2.配置一些公共信息。需要新建一个类，这里是ApiConfig.java.(这个可以不用配置，swagger有默认，但是最好设置下接口的公共信息)

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.ComponentScan;

import org.springframework.context.annotation.Configuration;

import org.springframework.stereotype.Component;