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

网页布局实训心得体会太原建站seo

网页布局实训心得体会,太原建站seo,加强网站信息内容建设管理,web开发用什么软件文章目录 **1. 核心注解****Tag-Class类上** **2. 方法级别注解****Operation-方法描述****ApiResponse 和 ApiResponses-方法的返回结果** **3. 参数相关注解****Parameter-方法参数****Parameters方法参数(单个)** **4. 实体模型相关注解****Schema-描…

文章目录

  • **1. 核心注解**
    • **@Tag-Class类上**
  • **2. 方法级别注解**
    • **@Operation-方法描述**
    • **@ApiResponse 和 @ApiResponses-方法的返回结果**
  • **3. 参数相关注解**
    • **@Parameter-方法参数**
    • **@Parameters方法参数(单个)**
  • **4. 实体模型相关注解**
    • **@Schema-描述实体类或字段的信息**
  • **5. 其他注解**
    • **@Hidden-隐藏某个类、方法或参数**
  • **6. 配置相关注解(不常用)**
    • **@OpenAPIDefinition-全局配置 OpenAPI 文档的元信息**
  • **7. 总结**

系列文章:
springboot-swagger详解
springboot-优美的Knife4j文档-Swagger进化
Spring Cloud Gateway 网关整合 Knife4j
SpringBoot之如何集成SpringDoc最详细文档

1. 核心注解

@Tag-Class类上

  • 作用:为控制器或方法分组,便于组织和分类 API。

  • 常用属性

    • name:标签名称。
    • description:标签描述信息。
  • 示例

      @Tag(name = "策略库接口",description = "这是策略库的所有接口")@RestController@RequestMapping("/tacticsInfo")public class TacticsInfoController extends BaseController{// ...}
    

在这里插入图片描述

2. 方法级别注解

@Operation-方法描述

  • 作用:描述一个 API 方法的功能。
  • 常用属性
    • summary:方法的简短描述。
    • description:方法的详细描述。
    • responses:定义可能的响应结果。
    • deprecated:标记方法是否已废弃。
  • 示例
      @Operation(summary = "查询策略库:tactics_info列表",description = "查询策略库:tactics_info列表-list接口")@RequiresPermissions("business:tacticsInfo:list")@GetMapping("/list")public TableDataInfo list(TacticsInfo tacticsInfo){// ...
    }
    

在这里插入图片描述

@ApiResponse 和 @ApiResponses-方法的返回结果

  • 作用:描述 API 方法的响应结果。
  • 常用属性
    • responseCode:HTTP 状态码。
    • description:响应描述信息。
    • content:响应的内容类型(如 JSON、XML)。
  • 示例
    @Operation(summary = "创建用户", description = "根据用户信息创建新用户")
    @ApiResponses({@ApiResponse(responseCode = "200", description = "成功创建用户"),@ApiResponse(responseCode = "400", description = "请求参数错误"),@ApiResponse(responseCode = "500", description = "服务器内部错误")
    })
    @PostMapping
    public ResponseEntity<User> createUser(@RequestBody User user) {// ...
    }
    

3. 参数相关注解

@Parameter-方法参数

  • 作用:描述方法参数的含义。
  • 常用属性
    • name:参数名称。
    • description:参数描述信息。
    • required:是否必填。
    • example:参数示例值。
    • in:参数位置(如 pathqueryheader 等)。
  • 示例
    @Operation(summary = "根据 ID 获取用户")
    @GetMapping("/{id}")
    public User getUserById(@Parameter(name = "id", description = "用户 ID", required = true, example = "1") @PathVariable Long id) {// ...
    }
    

@Parameters方法参数(单个)

  • 作用:描述多个参数。
  • 示例
    @Operation(summary = "搜索用户")
    @Parameters({@Parameter(name = "name", description = "用户名", in = ParameterIn.QUERY),@Parameter(name = "age", description = "用户年龄", in = ParameterIn.QUERY)
    })
    @GetMapping("/search")
    public List<User> searchUsers(@RequestParam String name, @RequestParam Integer age) {// ...
    }
    

4. 实体模型相关注解

@Schema-描述实体类或字段的信息

  • 作用:描述实体类或字段的信息。
  • 常用属性
    • description:模型或字段的描述信息。
    • example:字段示例值。
    • required:字段是否必填。
    • type:字段的数据类型。
    • format:字段的格式(如 date-timeemail 等)。
  • 示例
    @Schema(description = "用户的基本信息")
    public class User {@Schema(description = "用户 ID", example = "1", required = true)private Long id;@Schema(description = "用户名", example = "John Doe", required = true)private String name;@Schema(description = "用户年龄", example = "25")private Integer age;// getters and setters
    }
    

5. 其他注解

@Hidden-隐藏某个类、方法或参数

  • 作用:隐藏某个类、方法或参数,不将其包含在生成的文档中。
  • 示例
    @Hidden
    @GetMapping("/internal")
    public String internalEndpoint() {return "This endpoint is ignored by springdoc.";
    }
    

6. 配置相关注解(不常用)

@OpenAPIDefinition-全局配置 OpenAPI 文档的元信息

  • 作用:全局配置 OpenAPI 文档的元信息。这个不常用,还是常用配置文件类型的
  • 常用属性
    • info:文档的基本信息(标题、版本、描述等)。
    • tags:全局标签定义。
    • servers:API 的服务器地址。
  • 示例
    @OpenAPIDefinition(info = @Info(title = "用户管理系统", version = "1.0", description = "用户相关的 API 文档"),tags = {@Tag(name = "用户管理", description = "与用户相关的操作")},servers = {@Server(url = "http://localhost:8080", description = "本地开发环境")}
    )
    @SpringBootApplication
    public class Application {public static void main(String[] args) {SpringApplication.run(Application.class, args);}
    }
    

7. 总结

以下是 springdoc 常用注解的分类总结:

注解作用
@Tag为控制器或方法分组,便于组织和分类 API。
@Operation描述 API 方法的功能。
@ApiResponse描述单个响应结果。
@Parameter描述方法参数的含义。
@Schema描述实体类或字段的信息。
@Hidden隐藏某个类、方法或参数,不包含在生成的文档中。
@OpenAPIDefinition全局配置 OpenAPI 文档的元信息(标题、版本、描述等)。
http://www.dtcms.com/wzjs/57546.html

相关文章:

  • 一般建设一个网站多少钱优化推广
  • 营销型商务网站应用商店下载
  • 做外贸没有网站需要注意什么问题厦门最快seo
  • 公司邮箱怎么注册流程黑帽seo优化软件
  • 家具网站建设规划书国内最好的搜索引擎
  • 怎么推广自己做的网站吗2020国内搜索引擎排行榜
  • 重庆网站查询广告软文营销平台
  • 健身网站怎么做爱站网关键词密度
  • 湖南做网站成人技术培训学校
  • 简要说明网站建设的步骤权重查询入口
  • 颍泉网站建设百度推广基木鱼
  • 四川公司网站建设招标怎么做一个网站平台
  • 旅游网站建设首选赢旅动力seo裤子的关键词首页排名有哪些
  • 怎么用centos做网站国际军事新闻今日头条
  • 山东川畅科技做网站多少钱线上平台怎么推广
  • 云南新冠疫情最新动态长沙网站seo收费标准
  • 网站建设需要的条件软文写作的技巧
  • 国外炫网站我想做个网站怎么做
  • html网站模板免费下载广州seo公司
  • asp动态网站建设百度关键词优化企业
  • 百度做网站教程sem竞价推广托管代运营公司
  • 如何做建筑一体化的网站建站合肥网络公司seo
  • wordpress dome.php宁波网站排名优化seo
  • 基于p2p的网站建设产品seo怎么优化
  • 网站建设服务费下什么科目超八成搜索网站存在信息泄露问题
  • 做ppt的模板网站有哪些长春网站搭建
  • 厦门专业做网站的公司网站运营推广
  • 信用门户网站建设太原百度公司地址
  • 男女做的那个真实的视频网站网站搜索排优化怎么做
  • asp网站开发教程pdf识图找图