jellyfin使用教程,笔记详情的制作

张世龙 05-05 21:12 107次浏览

1. Swagger个人资料前后端分离

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

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

前后端通过API进行对话

前后端相对独立，且松散耦合

产生的问题

前后整合，无法在前端或后端“及时协商、及早解决”，最终集中爆发问题

解决方案

首先，定义架构“计划概览”并实时跟踪最新的API，以降低整合风险

Swagger

它被称为世界上最受欢迎的API框架

rest风格的API文档在线自动生成器=API 文档与API 定义同步更新

直接运行，在线测试API

支持多种语言，如Java、PHP

官网： https://swagger.io/

2. SpringBoot集成swagger 3358 www.Sina.com/=http://www.Sina.com /，两个jar软件包

SpringBoot集成Swagger

swagger-springmvc

springfox

要求：只有jdk 1.8才能运行swagger2

步骤：

1、新建SpringBoot-web项目

2、添加Maven依赖项

！ - https://mvn repository.com/artifact/io.spring fox/spring fox-swagger2--dependencygroupidio.spring fox/groupidadadad io.spring fox/spring fox-swagger-ui--从属cygroupidio.spring fox/groupid artifactidversion2.9.2/version /

4、要使用Swagger，必须创建-SwaggerConfig，它是配置Swagger的配置类

@Configuration //配置类@enableswagger2//swagger2自动配置公共类swagger config { } 5，访问测试： http://localhost 33608080/sswager 2

3.Swagger1，因为配置Swagger实例Bean的是Docket，所以通过配置Docket实例来配置Swagger。

配置docket以配置@bean//swagger特定参数public Docket docket () (返回新docket ) documentationtype.swagger_2)； } 2、apiInfo (可以通过属性设置文档信息

//文档信息private ApiInfo apiInfo () { Contact contact=new Contact )、(联系人姓名)、(http://xxx.xxx.com/联系人访问链接)、)联系人邮件returnnewAPIinfo('Swagger学习'，//标题'学习演示Swagger '，//说明' v1.0 '，//版本' http://terms.service.url/组织链接'，)

@Beanpublic Docket docket () returnnewdocket ) documentationtyp

e.SWAGGER_2).apiInfo(apiInfo());}

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

4. 配置扫描接口

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

@Beanpublic Docket docket() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口 .apis(RequestHandlerSelectors.basePackage("com.dary.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、除此之外，我们还可以配置接口扫描过滤：

5、这里的可选值还有

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

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

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

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

@Beanpublic 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.dary.swagger.controller")) // 配置如何通过path过滤,即这里只扫描请求以/kuang开头的接口 .paths(PathSelectors.ant("/dary/**")) .build();}

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

6. 配置API分组

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

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

2、重启项目查看分组

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

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

4、重启项目查看即可

7. 实体配置

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为类属性添加注释

8. 常用注解

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("dary的接口")@PostMapping("/dary")@ResponseBodypublic String dary(@ApiParam("这个名字会被返回")String username){ return username;}

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

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

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

9. 拓展：其他皮肤

我们可以导入不同的包实现不同的皮肤定义：

1、默认的 访问 http://localhost:8080/swagger-ui.html

<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version></dependency>

2、bootstrap-ui 访问 http://localhost:8080/doc.html

<dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>swagger-bootstrap-ui</artifactId> <version>1.9.1</version></dependency>

3、Layui-ui 访问 http://localhost:8080/docs.html

<dependency> <groupId>com.github.caspar-chen</groupId> <artifactId>swagger-ui-layer</artifactId> <version>1.1.3</version></dependency>

4、mg-ui 访问 http://localhost:8080/document.html

<dependency> <groupId>com.zyplayer</groupId> <artifactId>swagger-mg-ui</artifactId> <version>1.0.6</version></dependency>