swagger2配置的那些事

应项目组要求运用swagger技术管理项目接口文档,由于项目运用的springBoot开发,所以这里我说一下swagger的一些相关配置和需要注意的地方。下边先说一下使用swagger2之前做的一些步骤。

第一步,引入swagger相关jar的pom。为了便于大家直接拷贝这里没有插入图片(此处应有赞赞!!!),大家可以直接copy。


<dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-swagger2</artifactId>

<version>2.6.1</version>

</dependency>

<dependency>

<groupId>io.springfox</groupId>

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

<version>2.6.1</version>

</dependency>


第二步,配置项目运行的bean,这里可能大家不懂了(可以看一下springBoot相关的知识点),总结网上的一些资料,主要有两种的配置方式,区别在于扫描包的单与多,即是否支持多包扫描的配置。下边分别说明。

A、单路劲扫描配置,抒写swagger2类。



import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;

import springfox.documentation.builders.ApiInfoBuilder;

import springfox.documentation.builders.PathSelectors;

import springfox.documentation.builders.RequestHandlerSelectors;

import springfox.documentation.service.ApiInfo;

import springfox.documentation.spi.DocumentationType;

import springfox.documentation.spring.web.plugins.Docket;

@Configuration

@EnableSwagger2

public class Swagger2 {

@Bean

public Docket createRestApi() {

return new Docket(DocumentationType.SWAGGER_2)

.apiInfo(apiInfo())

.select()

.apis(RequestHandlerSelectors.basePackage("com.luckin.ai.backend.ui.controller"))//单路径扫描

.paths(PathSelectors.any())

.build();

}

private ApiInfo apiInfo() {

return new ApiInfoBuilder()

.title("项目接口文档")//项目描述1

.description("简单优雅的restfun风格")//项目描述2

.termsOfServiceUrl("http://blog.csdn.net/saytime")//项目描述3

.version("1.0")

.build();

}

}


B、多路径扫描(抒写Swagger2UIConfig类)



import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;

import com.google.common.base.Function;

import com.google.common.base.Optional;

import com.google.common.base.Predicate;

import springfox.documentation.RequestHandler;

import springfox.documentation.builders.ApiInfoBuilder;

import springfox.documentation.builders.PathSelectors;

import springfox.documentation.service.ApiInfo;

import springfox.documentation.spi.DocumentationType;

import springfox.documentation.spring.web.plugins.Docket;

import springfox.documentation.swagger2.annotations.EnableSwagger2;


@Configuration

@EnableSwagger2

public class Swagger2UIConfig {

    @Bean

    public Docket createRestApi() {

        return new Docket(DocumentationType.SWAGGER_2)

        .apiInfo(apiInfo())

        .select()

                .apis(Swagger2UIConfig.basePackage("com.luckin.ai.backend.ui.controller,com.luckin.ai.report.controller"))//多路径扫描,之间用逗号分隔

                .paths(PathSelectors.any()).build();

    }



    public static Predicate<RequestHandler> basePackage(final String basePackage) {

        return new Predicate<RequestHandler>() {


            @Override

            public boolean apply(RequestHandler input) {

                return declaringClass(input).transform(handlerPackage(basePackage)).or(true);

            }

        };

    }


    private static Function<Class<?>, Boolean> handlerPackage(final String basePackage) {

        return new Function<Class<?>, Boolean>() {


            @Override

            public Boolean apply(Class<?> input) {

                for (String strPackage : basePackage.split(",")) {

                    boolean isMatch = input.getPackage().getName().startsWith(strPackage);

                    if (isMatch) {

                        return true;

                    }

                }

                return false;

            }

        };

    }


    /**

    * @param input RequestHandler

    * @return Optional

    */

    private static Optional<? extends Class<?>> declaringClass(RequestHandler input) {

        return Optional.fromNullable(input.declaringClass());

    }


    @Bean

    public ApiInfo apiInfo() {

        return new ApiInfoBuilder()

        .title("智能平台接口文档")

.description("")

            .version("1.0")

            .build();

    }

}


如上两种配置都可以,区别便是可以多路径扫描,路径之间用逗号分隔。

第三步,抒写接口配置注释,这样项目才能扫描到需要展示的接口api来生成文档。下边介绍一下用到的注释。

@Api:修饰整个类,描述Controller的作用

@ApiOperation:描述一个类的一个方法,或者说一个接口

@ApiParam:单个参数描述

@ApiModel:用对象来接收参数

@ApiProperty:用对象接收参数时,描述对象的一个字段

@ApiResponse:HTTP响应其中1个描述

@ApiResponses:HTTP响应整体描述

@ApiIgnore:使用该注解忽略这个API

@ApiError :发生错误返回的信息

@ApiImplicitParam:一个请求参数

@ApiImplicitParams:多个请求参数

因为网上有关swagger接口注释示例很多,这里就不再给大家废话了,主要说明一下大概会遇到的几种方式下边是给大家的一下示例:

多参数的配置说明


单一参数配置说明


实体类参数配置说明

上边需要注意的地方是dataType需要对应,大家可能想问paramType是什么,这里说明以下这个坑。paramType的参数有以下几种方式:

header:请求参数放置于Request Header,使用@RequestHeader获取

query:请求参数放置于请求地址,使用@RequestParam获取

path:(用于restful接口)-->请求参数的获取:@PathVariable

body(一般不用)

form(一般不用)

注意:这个paramType必须对应才能在最后展示的接口文档界面发送请求。

第四步,可以启动项目了,启动以后访问地址:http://your ip:your 端口/swagger-ui.html,配置没问题的话会展示如下界面:


需要等待几秒钟,正在扫描需要生成文档的配置。




成功界面

走到这里,大家可能会发现我的界面怎么是英文的尼,接下来给大家说一下swagger的汉化操作。

首先找到刚开始引入pom的jar


找到这个jar包修改swagger-ui.hmtl中加入js引用:

<!--国际化操作:选择中文版 -->

<script src='webjars/springfox-swagger-ui/lang/translator.js' type='text/javascript'></script>

<script src='webjars/springfox-swagger-ui/lang/zh-cn.js' type='text/javascript'></script>

重新打包,你会发现界面已经显示为中文。

本文是我写的第一遍随笔,谢谢大家的支持。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,033评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,725评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,473评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,846评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,848评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,691评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,053评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,700评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,856评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,676评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,787评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,430评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,034评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,990评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,218评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,174评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,526评论 2 343

推荐阅读更多精彩内容