本篇文章为你整理了Swagger以及knife4j的基本使用（）的详细内容，包含有 Swagger以及knife4j的基本使用，希望能帮助你了解 Swagger以及knife4j的基本使用。
Swagger以及knife4j基本使用
目录Swagger以及knife4j基本使用Swagger 介绍：Restful 面向资源SpringBoot使用swaggerKnife4j --Swagger增强工具
Swagger 介绍：
官网：https://swagger.io/
Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful风格的 Web 服务
Restful 面向资源
RESTful是一种架构的规范与约束、原则，符合这种规范的架构就是RESTful架构
Rest是web服务的一种架构风格；使用HTTP，URI，XML，JSON，HTML等广泛流行的标准和协议；轻量级，跨平台，跨语言的架构设计，它是一种设计风格，不是一种标准，是一种思想。
说明：
幂等性：对同一REST接口多次访问，得到的资源状态是相同的
安全性：对该REST接口访问，不会使服务端资源状态发生改变
优点：
HTTP本身提供了丰富的内容协商手段（缓存，资源修改的乐观并发控制等可以通过与业务无关的中间件实现）
* apiInfo() 增加API相关信息
* 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现，
* 指定扫描的包路径来定义指定要建立API的目录。
* @return
@Bean
public Docket docket(){
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(adminApiInfo())
//.enable(false) //enable是否启动Swagger 如果为false，则swagger不能在浏览器中访问
.groupName("adminApi")
.select()
//RequestHandlerSelectors 配置要扫描接口的方式
//basePackage: 指定要扫描的包
//any()：扫描全部
//none()不扫描
//withClassAnnotation: 扫描类上的注解，参数为一个注解的反射对象
//withMethodeAnnotation: 扫描方法上的注解
.apis(RequestHandlerSelectors.basePackage("com.example.swagger.controller"))
//只显示admin下面的路径
.paths(Predicates.and(PathSelectors.regex("/admin/.*")))
.build();
private ApiInfo adminApiInfo(){
return new ApiInfoBuilder()
.title("api文档")
.description("系统接口描述")
.version("1.0")
//作者信息
.contact(new Contact("张三","http://baidu.com","12345678@qq.com"))
.build();
编写接口请求并运行
public String getUser(@ApiParam("用户名")String username){
return "名字为："+username;
@ApiImplicitParam：描述一个请求参数，可以配置参数的中文含义，还可以给参数设置默认值
//eg:
@ApiImplicitParam(name="username",value="用户名",required=true)
Knife4j --Swagger增强工具
使用Knife4j2.06以上版本，springboot版本必须大于等于2.2.x
作用
groupId com.github.xiaoymin /groupId
artifactId knife4j-spring-boot-starter /artifactId
version 2.0.9 /version
/dependency
添加SwaggerConfiguration作为Swagger2的配置类
@Configuration
@EnableSwagger2
@EnableKnife4j
//@EnableSwagger2WebMvc 2.6以上报空指针异常则需要添加
@Import(BeanValidatorPluginsConfiguration.class)
public class SwaggerConfiguration {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2) // 选择swagger2版本
.apiInfo(apiInfo()) //定义api文档汇总信息
.select()
.apis(RequestHandlerSelectors
.basePackage("com.example")) // 指定生成api文档的包
.paths(PathSelectors.any()) // 指定所有路径
.build();
* 构建文档api信息
* @return
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("") // 文档标题
.contact(new Contact("", "", "")) //联系人信息
.description("") //描述
.version("1.0.1") //文档版本号
.termsOfServiceUrl("") //网站地址
.build();
实现生产环境关闭文档资源
spring:
profiles: prod #指定环境
knife4j:
production: true #开启屏蔽文档资源
实现接口排序
以上就是Swagger以及knife4j的基本使用（）的详细内容，想要了解更多 Swagger以及knife4j的基本使用的内容，请持续关注盛行IT软件开发工作室。
郑重声明：本文由网友发布，不代表盛行IT的观点，版权归原作者所有，仅为传播更多信息之目的，如有侵权请联系，我们将第一时间修改或删除，多谢。