企业官网建设流程全解析

2015年做哪个网站致富,wordpress 截取摘要,中关村丰台园,阿里云模板建站教程目录 一、简介 二、基本使用 1. 引入依赖 2. 其它相关依赖 2. 编写配置文件 3. 配置Swagger文档基本信息 4.?控制 Swagger 的开启 ?编辑?5. 完善Swagger文档 5.1 实体类添加Swagger注解 5.2?控制器注解解析 6. 接口调用 三、使用postman进行接口测试 1. 导入链…目录一、简介二、基本使用1. 引入依赖2. 其它相关依赖2. 编写配置文件3. 配置Swagger文档基本信息4.?控制 Swagger 的开启?编辑?5. 完善Swagger文档5.1 实体类添加Swagger注解5.2?控制器注解解析6. 接口调用三、使用postman进行接口测试1. 导入链接四、代码一、简介官网https://swagger.io/对于SpringBoot而言Swagger的作用是通过后端SpringBoot代码快速生成接口文档方便测试接口以及前端使用。二、基本使用由于springfox不适用于SpringBoot3.x故使用Springdoc进行代替。1. 引入依赖dependency groupIdorg.springdoc/groupId artifactIdspringdoc-openapi-starter-webmvc-ui/artifactId version2.6.0/version /dependency2. 其它相关依赖dependency groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-web/artifactId /dependency !-- 让响应结果更美观 -- dependency groupIdcom.alibaba.cola/groupId artifactIdcola-component-dto/artifactId version4.3.2/version /dependency2. 编写配置文件添加 swagger 的配置文件SwaggerConfig.javaConfiguration public class SwaggerConfig { }此时Swagger已经简单整合成功运行SpringBoot服务浏览器打开网址进行测试http://localhost:8080/swagger-ui/index.html我使用的是8081端口因此我使用下面的链接打开http://localhost:8081/swagger-ui/index.html3. 配置Swagger文档基本信息Configuration public class SwaggerConfig { /* 配置swagger基本信息 */ Bean public OpenAPI swaggerOpenApi() { return new OpenAPI() .info(new Info().title(Swagger学习-) .description(Swagger简单入门) .version(v1.0)) .externalDocs(new ExternalDocumentation() .description(我的博客) .url(https://blog.csdn.net/2202_76007821?spm1000.2115.3001.5343)); } }此时重新运行服务打开网址http://localhost:8081/swagger-ui/index.html4.控制 Swagger 的开启在开发或者测试环境下我们开启 swagger 会方便前端和后端的交互但是如果在生产环境下也开启 swagger 的话是会将接口暴露出去的有极大风险如何让 swagger 根据不同的环境来决定是否开启这里我准备了四个项目的配置文件dev、prod两个环境的配置文件仅是端口上的不同application.yml -------------------------- 全局配置文件application-dev.yml -------------------- 开发环境配置文件application-prod.yml -------------------- 生产环境配置文件application-dev.yml配置springdoc: api-docs: enabled: true # 开启OpenApi接口 swagger-ui: enabled: true # 开启swagger界面依赖OpenApi需要OpenApi同时开启application-prod.yml配置springdoc: api-docs: enabled: false # 关闭OpenApi接口 swagger-ui: enabled: false # 关闭swagger界面application.yml内容如下用于指定选择的环境spring: profiles: active: dev在application.yml全局配置文件中环境指向dev时是可以打开 swagger 的如果我将application.yml全局配置文件中环境指向prod时就不能打开 swagger 了5. 完善Swagger文档5.1 实体类添加Swagger注解Component Schema(title 水果类) public class Fruit { Schema(title 水果名称,example 塔菲新式番茄,minLength 1,maxLength 100) private String name; Schema(title 水果数量,example 520) private Integer num ; public String getName() { return name; } public void setName(String name) { this.name name; } public Integer getNum() { return num; } public void setNum(Integer num) { this.num num; } }Schema: Swagger文档的注解用于说明类/字段title: 类/字段说明example: 示例Swagger中会将这个字段作为示例minLength/maxLength: 最小/最大长度字段为String类型时生效(仅用于文档说明不会抛出异常)5.2控制器注解解析RestController RequestMapping(/fruit) Tag(name 水果控制器,description 这是水果测试接口) public class FruitController { PostMapping(/add) Operation(summary 新增水果,description 这是新增水果的方法) public String add(Fruit fruit) { return 新增成功; } }Tag: 控制器说明name: 名称description: 描述说明Operation: 请求说明summary: 说明Swagger页面在方法后面不会被折叠descirption: 描述会被折叠到方法说明中配置之后让我们打开网址查看一下6. 接口调用点击进行测试测试成功三、使用postman进行接口测试1. 导入链接回到文档头部点击api-docs复制链接打开postman点击import选择第二个进行导入baseurl问题使用环境进行统一修改即可点击创建新环境手动修改参数点击进行测试四、代码代码已经上传到gitee打开网址点击下载zip即可https://gitee.com/guirongyuan/swagger-leaning