swagger 入门配置

最新推荐文章于 2024-08-29 08:37:37 发布

sloar阳

最新推荐文章于 2024-08-29 08:37:37 发布

阅读量285

点赞数

分类专栏：工具文章标签： swagger swagger配置

本文链接：https://blog.csdn.net/weixin_43936132/article/details/103318573

版权

工具专栏收录该内容

6 篇文章 0 订阅

订阅专栏

配置

1. 在maven中添加

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

2.创建配置文件

@EnableSwagger2
public class SwaggerConfiguration {

    @Bean
    public Docket myDocket() {
        Docket docket = new Docket(DocumentationType.SWAGGER_2);
        ApiInfo apiInfo = new ApiInfo("测试",
                "测试",
                "1.0",
                "index.html",
                "jzyadmin@163.com",
                "官网",
                "http://www.jzyadmin.cn");
        docket.apiInfo(apiInfo);
        return docket;
    }
}

3.在spring配置文件中加载bean

<bean class="com.corner.mobile.common.config.SwaggerConfiguration"></bean>
<mvc:resources mapping="/resources/**" location="/resources/" />

4.swagger ui文件处理

[ *下载swagger-ui文件*](https://github.com/swagger-api/swagger-ui)
下载后将文件放入webapp/resources下

打开dist/index.html进行修改

将
http://petstore.swagger.io/v2/swagger.json

修改
/{porjectName}/v2/api-docs

注若：项目的web.xml中有拦截请求则在最后加上.do
<servlet-mapping>
	<servlet-name>dispatcherServlet</servlet-name>
	<url-pattern>*.do</url-pattern>
</servlet-mapping>

使用Swagger特定注解

Swagger 包含了一些特定的注解，可以更好的显示API，比如:

@API表示一个开放的API，可以通过description简要描述该API的功能，一般和 Spring 的 @Controller一起。
在一个@API下，可有多个@ApiOperation，表示针对该API的CRUD操作。在ApiOperation Annotation中可以通过value，notes描述该操作的作用，response描述正常情况下该请求的返回对象类型。
在一个ApiOperation下，可以通过ApiResponses描述该API操作可能出现的异常情况。
@ApiParam用于描述该API操作接受的参数类型
@ApiModel用来描述封装的参数对象与返回的参数对象
@ApiModelProperty描述ApiModel的属性