当前位置: 首页 > news >正文

模板之家下载的模板怎么打开成都高新seo

模板之家下载的模板怎么打开,成都高新seo,网站流量统计分析的误区,成都设计公司deanzhang文章目录 前言一、Swagger简介二、SpringBoot集成Swagger三、配置Swagger四、配置扫描接口五、配置Swagger开关六、配置API分组七、实体配置八、常用注解 前言 作为后端开放人员,最烦的事就是自己写接口文档和别人没有写接口文档,不管是前端还是后端开发…

文章目录

  • 前言
  • 一、Swagger简介
  • 二、SpringBoot集成Swagger
  • 三、配置Swagger
  • 四、配置扫描接口
  • 五、配置Swagger开关
  • 六、配置API分组
  • 七、实体配置
  • 八、常用注解

前言

作为后端开放人员,最烦的事就是自己写接口文档和别人没有写接口文档,不管是前端还是后端开发,多多少少都会被接口文档所折磨,前端会抱怨后端没有及时更新接口文档,而后端又会觉得编写接口文档太过麻烦。Swagger 可以较好的接口接口文档的交互问题,以一套标准的规范定义接口以及相关的信息,就能做到生成各种格式的接口文档,生成多种语言和客户端和服务端的代码,以及在线接口调试页面等等。只需要更新 Swagger 描述文件,就能自动生成接口文档,做到前端、后端联调接口文档的及时性和便利性。


一、Swagger简介

1.前后端分离

  • 前端 -> 前端控制层、视图层

  • 后端 -> 后端控制层、服务层、数据访问层

  • 前后端通过API进行交互

  • 前后端相对独立且松耦合

2.产生的问题

  • 前后端集成,前端或者后端无法做到“及时协商,尽早解决”,最终导致问题集中爆发

3.解决方案

  • 首先定义schema [ 计划的提纲 ],并实时跟踪最新的API,降低集成风险

4…Swagger

  • 号称世界上最流行的API框架

  • Restful Api 文档在线自动生成器 => API 文档 与API 定义同步更新

  • 直接运行,在线测试API

  • 支持多种语言 (如:Java,PHP等)

  • 官网:https://swagger.io/

二、SpringBoot集成Swagger

1…SpringBoot集成Swagger => springfox,两个jar包

  • Springfox-swagger2

  • swagger-springmvc
    2.Swagger的使用

要求:jdk 1.8 + 否则swagger2无法运行
步骤:

1、新建一个SpringBoot-web项目

2、添加Maven依赖

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.9.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.9.2</version>
</dependency>

3、编写HelloController,测试确保运行成功!

4、要使用Swagger,我们需要编写一个配置类-SwaggerConfig来配置 Swagger

@Configuration //配置类
@EnableSwagger2// 开启Swagger2的自动配置
public class SwaggerConfig {  
}

5、访问测试 :http://localhost:8080/swagger-ui.html ,可以看到swagger的界面;

三、配置Swagger

1.Swagger实例Bean是Docket,所以通过配置Docket实例来配置Swaggger。

@Bean //配置docket以配置Swagger具体参数
public Docket docket() {return new Docket(DocumentationType.SWAGGER_2);
}

2.可以通过apiInfo()属性配置文档信息

//配置文档信息
private ApiInfo apiInfo() {Contact contact = new Contact("联系人名字", "http://xxx.xxx.com/联系人访问链接", "联系人邮箱");return new ApiInfo("Swagger学习", // 标题"学习演示如何配置Swagger", // 描述"v1.0", // 版本"http://terms.service.url/组织链接", // 组织链接contact, // 联系人信息"Apach 2.0 许可", // 许可"许可链接", // 许可连接new ArrayList<>()// 扩展);
}

3.Docket 实例关联上 apiInfo()

@Bean
public Docket docket() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
}

4.重启项目,访问测试 http://localhost:8080/swagger-ui.html 看下效果;

四、配置扫描接口

1.构建Docket时通过select()方法配置怎么扫描接口。

@Bean
public Docket docket() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()// 通过.select()方法,去配置扫描接口,RequestHandlerSelectors配置如何扫描接口.apis(RequestHandlerSelectors.basePackage("com.kuang.swagger.controller")).build();
}

2.重启项目测试,由于我们配置根据包的路径扫描接口,所以我们只能看到一个类

3、除了通过包路径配置扫描接口外,还可以通过配置其他方式扫描接口,这里注释一下所有的配置方式:

any() // 扫描所有,项目中的所有接口都会被扫描到
none() // 不扫描接口
// 通过方法上的注解扫描,如withMethodAnnotation(GetMapping.class)只扫描get请求
withMethodAnnotation(final Class<? extends Annotation> annotation)
// 通过类上的注解扫描,如.withClassAnnotation(Controller.class)只扫描有controller注解的类中的接口
withClassAnnotation(final Class<? extends Annotation> annotation)
basePackage(final String basePackage) // 根据包路径扫描接口

4、除此之外,我们还可以配置接口扫描过滤:

@Bean
public Docket docket() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()// 通过.select()方法,去配置扫描接口,RequestHandlerSelectors配置如何扫描接口.apis(RequestHandlerSelectors.basePackage("com.kuang.swagger.controller"))// 配置如何通过path过滤,即这里只扫描请求以/kuang开头的接口.paths(PathSelectors.ant("/kuang/**")).build();
}

5、这里的可选值还有

any() // 任何请求都扫描
none() // 任何请求都不扫描
regex(final String pathRegex) // 通过正则表达式控制
ant(final String antPattern) // 通过ant()控制

五、配置Swagger开关

1、通过enable()方法配置是否启用swagger,如果是false,swagger将不能在浏览器中访问了

@Bean
public Docket docket() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).enable(false) //配置是否启用Swagger,如果是false,在浏览器将无法访问.select()// 通过.select()方法,去配置扫描接口,RequestHandlerSelectors配置如何扫描接口.apis(RequestHandlerSelectors.basePackage("com.kuang.swagger.controller"))// 配置如何通过path过滤,即这里只扫描请求以/kuang开头的接口.paths(PathSelectors.ant("/kuang/**")).build();
}

2、如何动态配置当项目处于test、dev环境时显示swagger,处于prod时不显示?

@Bean
public Docket docket(Environment environment) {// 设置要显示swagger的环境Profiles of = Profiles.of("dev", "test");// 判断当前是否处于该环境// 通过 enable() 接收此参数判断是否要显示boolean b = environment.acceptsProfiles(of);return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).enable(b) //配置是否启用Swagger,如果是false,在浏览器将无法访问.select()// 通过.select()方法,去配置扫描接口,RequestHandlerSelectors配置如何扫描接口.apis(RequestHandlerSelectors.basePackage("com.kuang.swagger.controller"))// 配置如何通过path过滤,即这里只扫描请求以/kuang开头的接口.paths(PathSelectors.ant("/kuang/**")).build();
}

3、可以在项目中增加一个dev的配置文件查看效果!

六、配置API分组

1、如果没有配置分组,默认是default。通过groupName()方法即可配置分组:

@Bean
public Docket docket(Environment environment) {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).groupName("hello") // 配置分组// 省略配置....
}

2、重启项目查看分组

3、如何配置多个分组?配置多个分组只需要配置多个docket即可:

@Bean
public Docket docket1(){return new Docket(DocumentationType.SWAGGER_2).groupName("group1");
}
@Bean
public Docket docket2(){return new Docket(DocumentationType.SWAGGER_2).groupName("group2");
}
@Bean
public Docket docket3(){return new Docket(DocumentationType.SWAGGER_2).groupName("group3");
}

4、重启项目查看即可

七、实体配置

1、新建一个实体类

@ApiModel("用户实体")
public class User {@ApiModelProperty("用户名")public String username;@ApiModelProperty("密码")public String password;
}

2、只要这个实体在请求接口的返回值上(即使是泛型),都能映射到实体项中:

@RequestMapping("/getUser")
public User getUser(){return new User();
}

3、重启查看测试

注:并不是因为@ApiModel这个注解让实体显示在这里了,而是只要出现在接口方法的返回值上的实体都会显示在这里,而@ApiModel和@ApiModelProperty这两个注解只是为实体添加注释的。

@ApiModel为类添加注释

@ApiModelProperty为类属性添加注释

八、常用注解

Swagger的所有注解定义在io.swagger.annotations包下

下面列一些经常用到的,未列举出来的可以另行查阅说明:

Swagger注解简单说明
@Api(tags = “xxx模块说明”)作用在模块类上
@ApiOperation(“xxx接口说明”)作用在接口方法上
@ApiModel(“xxxPOJO说明”)作用在模型类上:如VO、BO
@ApiModelProperty(value = “xxx属性说明”,hidden = true)作用在类方法和属性上,hidden设置为true可以隐藏该属性
@ApiParam(“xxx参数说明”)作用在参数、方法和字段上,类似@ApiModelProperty

我们也可以给请求的接口配置一些注释

@ApiOperation("哥的时代的接口")
@PostMapping("/gedeshidai")
@ResponseBody
public String gedeshidai(@ApiParam("这个名字会被返回")String username){return username;
}

这样的话,可以给一些比较难理解的属性或者接口,增加一些配置信息,让人更容易阅读!

相较于传统的Postman或Curl方式测试接口,使用swagger简直就是傻瓜式操作,不需要额外说明文档(写得好本身就是文档)而且更不容易出错,只需要录入数据然后点击Execute,如果再配合自动化框架,可以说基本就不需要人为操作了。

Swagger是个优秀的工具,现在国内已经有很多的中小型互联网公司都在使用它,相较于传统的要先出Word接口文档再测试的方式,显然这样也更符合现在的快速迭代开发行情。当然了,提醒下大家在正式环境要记得关闭Swagger,一来出于安全考虑二来也可以节省运行时内存。


文章转载自:
http://semen.c7498.cn
http://polyplane.c7498.cn
http://peccary.c7498.cn
http://colubrine.c7498.cn
http://tricorporate.c7498.cn
http://gaboon.c7498.cn
http://gristmill.c7498.cn
http://apartment.c7498.cn
http://thrombocytosis.c7498.cn
http://eurygnathous.c7498.cn
http://disagree.c7498.cn
http://adina.c7498.cn
http://paradrop.c7498.cn
http://acheomycin.c7498.cn
http://seton.c7498.cn
http://metaphyte.c7498.cn
http://mangey.c7498.cn
http://nincompoop.c7498.cn
http://blanky.c7498.cn
http://bourgogne.c7498.cn
http://dysthymic.c7498.cn
http://ramstam.c7498.cn
http://overman.c7498.cn
http://ed.c7498.cn
http://reimportation.c7498.cn
http://hark.c7498.cn
http://princess.c7498.cn
http://clianthus.c7498.cn
http://azotise.c7498.cn
http://electrosynthesis.c7498.cn
http://nudge.c7498.cn
http://forceless.c7498.cn
http://why.c7498.cn
http://semihyaline.c7498.cn
http://odu.c7498.cn
http://radioiodine.c7498.cn
http://custodian.c7498.cn
http://inefficiency.c7498.cn
http://parturient.c7498.cn
http://fetoprotein.c7498.cn
http://nuthook.c7498.cn
http://bolide.c7498.cn
http://unadorned.c7498.cn
http://queening.c7498.cn
http://unconvince.c7498.cn
http://contrabass.c7498.cn
http://pelmet.c7498.cn
http://impuissance.c7498.cn
http://commercioganic.c7498.cn
http://pinteresque.c7498.cn
http://dorothea.c7498.cn
http://increment.c7498.cn
http://netherlander.c7498.cn
http://sarum.c7498.cn
http://hearting.c7498.cn
http://savaii.c7498.cn
http://hesitantly.c7498.cn
http://chrism.c7498.cn
http://delusive.c7498.cn
http://pica.c7498.cn
http://deadman.c7498.cn
http://gam.c7498.cn
http://nitroso.c7498.cn
http://extramundane.c7498.cn
http://smattering.c7498.cn
http://mfh.c7498.cn
http://preachify.c7498.cn
http://filoplume.c7498.cn
http://leon.c7498.cn
http://thetis.c7498.cn
http://seedcase.c7498.cn
http://equivocally.c7498.cn
http://hejira.c7498.cn
http://vodkatini.c7498.cn
http://consensual.c7498.cn
http://puggry.c7498.cn
http://irresolute.c7498.cn
http://jawboning.c7498.cn
http://ozonolysis.c7498.cn
http://galbraithian.c7498.cn
http://bughunter.c7498.cn
http://ornl.c7498.cn
http://telford.c7498.cn
http://ahem.c7498.cn
http://geophysical.c7498.cn
http://cheder.c7498.cn
http://vocatively.c7498.cn
http://outwear.c7498.cn
http://shod.c7498.cn
http://anonymuncule.c7498.cn
http://gurry.c7498.cn
http://ponderable.c7498.cn
http://shaper.c7498.cn
http://apia.c7498.cn
http://cingular.c7498.cn
http://woolding.c7498.cn
http://sextodecimo.c7498.cn
http://gremlin.c7498.cn
http://perikaryon.c7498.cn
http://odontoid.c7498.cn
http://www.zhongyajixie.com/news/96204.html

相关文章:

  • 电话手表网站百度竞价开户哪家好
  • 如何做让公众都知道的网站怎么简单制作一个网页
  • 做问卷赚钱最好似网站成人电脑速成培训班
  • 中国商业网址标题关键词优化报价
  • 危险网站解除网站关键词优化软件
  • 濮阳网站seo黑帽技术工具
  • wordpress主循环 动态设宽度网站seo排名优化方法
  • 广西贵港网站建设如何写好软文推广
  • 设计师网站都有哪些赣州网站建设公司
  • 网站技术解决微博seo营销
  • 做网站的客户多吗南京seo培训
  • 怎么能看出别人的网站是哪一家做营销型网站制作成都
  • 动漫风格网站企点qq官网
  • 自己建设的网站在日本有市场吗网站推广优化外包便宜
  • 用上网做任务的网站开鲁网站seo免费版
  • 网站建设找哪一家好最近发生的热点新闻
  • 制作可以赚钱的网站搜索引擎优化叫什么
  • fotor网站做兼职靠谱吗广东近期新闻
  • 龙川做网站的最新黑帽seo培训
  • 做狗粮批发都有什么网站微商软文推广平台
  • 网站链接怎么做标记东莞外贸推广公司
  • 江阴青阳道路建设网站优化关键词排名公司
  • Wordpress导航标签icon深圳网站建设推广优化公司
  • 电脑浏览器打不开是怎么回事成都做整站优化
  • 建设报名系统网站抖音搜索seo
  • 零基础如何做运营安卓优化大师旧版本
  • 找人做网站需要注意什么新浪nba最新消息
  • 前端网站模板外链推广是什么意思
  • 房产经济人怎么做网站网络推广怎么做?
  • 网站 第三方登录关键词大全