Class OpenapiHttpEndpoint

java.lang.Object
io.github.xezzon.zeroweb.openapi.internal.OpenapiHttpEndpoint
@RestController @RequestMapping("/openapi") public class OpenapiHttpEndpoint extends Object
对外接口管理
Author:
xezzon

  • Constructor Details

    • OpenapiHttpEndpoint

      public OpenapiHttpEndpoint(OpenapiService openapiService)
      依赖注入
      Parameters:
      openapiService - 对外接口管理

  • Method Details

    • addOpenapi

      @PostMapping public io.github.xezzon.zeroweb.common.domain.Id addOpenapi(@RequestBody @Valid @Valid AddOpenapiReq req)
      新增对外接口
      Parameters:
      req - 包含添加对外接口请求数据的请求体
      Returns:
      添加的对外接口的唯一标识符

    • getOpenapiList

      @GetMapping public org.springframework.data.domain.Page<@NonNull Openapi> getOpenapiList(io.github.xezzon.zeroweb.core.odata.ODataRequestParam odata)
      获取对外接口列表的分页数据
      Parameters:
      odata - OData查询参数，用于分页和排序
      Returns:
      包含对外接口列表的分页对象

    • modifyOpenapi

      @PutMapping public void modifyOpenapi(@RequestBody @Valid @Valid ModifyOpenapiReq req)
      更新对外接口信息
      Parameters:
      req - 包含更新对外接口请求数据的请求体

    • publishOpenapi

      @PutMapping("/publish/{id}") public void publishOpenapi(@PathVariable @NotBlank @NotBlank String id)
      发布指定的对外接口
      Parameters:
      id - 要发布的对外接口的唯一标识符