使用OpenAPI 3.0 / Swagger在API中使用oauth2进行Autherization

如何解决使用OpenAPI 3.0 / Swagger在API中使用oauth2进行Autherization

我目前正在研究一个需要API的项目,为此,我选择使用OpenAPI 3.0生成它。我的目标语言是Spring Java。

我的问题是,我的服务器不会拒绝http请求,而使用我的oauth2安全方案未授权该请求者。

例如,如果用户没有来自授权服务器的令牌,则我希望对作业路径的GET请求返回401 NOT AUTHORIZED响应代码。相反,我只是被允许访问资源。

我创建了一个授权服务器,该服务器在localhost:9000上运行。如果我没有运行授权服务器,如果请求者未被授权(我错了吗?),我仍然希望我的API返回401 NOT AUTHORIZED响应代码。生成的API类似乎也具有包含授权范围和方案的正确注释(请参见下面的示例)。

有人可以看到我在做什么错吗?

系统版本:

Macos Catalina 10.15.7

Java 1.8

OpenAPI 3.03

openapi-generator-cli-4.3.1

Intellij 20.2.3

我的API在以下YAML文件中定义:

openapi: "3.0.3"
info:
  description: "API definition"
  version: "1.0.0"
  title: "Title"
servers:
  - url: http://localhost:8080

components:
  schemas:
    job:
      type: object
      properties:
        name:
          type: string
        id:
          type: integer
          format: i64
          default: 0
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: http://localhost:9000/oauth2/authorize
          tokenUrl: http://localhost:9000/oauth2/token
          scopes:
            read: Grants read access
            write: Grants write access
            admin: Grants access to admin operations
security:
  - OAuth2:
      - read
      - write

paths:
  /jobs:
    get:
      description: Returns a job file
      operationId: jobsGet
      "parameters": [
        {
          "in": "query","name": "name","description": "Job object that needs to be added to the store","required": true,"schema": {
            "$ref": '#/components/schemas/job'
          }
        }
      ]
      responses:
        '200':
          description: OK - Job recieved
          content:
            application/json:
              schema:
                type: string
                format: binary

    post:
      operationId: jobsPost
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                name:
                  type: string
                file:
                  type: string
                  format: binary
      responses:
        '200':
          description: OK - Job Posted
          content:
            application/json:
              schema:
                type: integer

作业API已生成。似乎正确吗?

@Validated
@Api(
    value = "jobs",description = "the jobs API"
)
public interface JobsApi {
    default Optional<NativeWebRequest> getRequest() {
        return Optional.empty();
    }

    @ApiOperation(
        value = "",nickname = "jobsGet",notes = "Returns a job file",response = Resource.class,authorizations = {@Authorization(
    value = "OAuth2",scopes = {@AuthorizationScope(
    scope = "read",description = "Grants read access"
),@AuthorizationScope(
    scope = "write",description = "Grants write access"
)}
)},tags = {}
    )
    @ApiResponses({@ApiResponse(
    code = 200,message = "OK - Job recieved",response = Resource.class
)})
    @RequestMapping(
        value = {"/jobs"},produces = {"application/json"},method = {RequestMethod.GET}
    )
    default ResponseEntity<Resource> jobsGet(@NotNull @ApiParam(value = "Job object that needs to be added to the store",required = true) @Valid Job name) {
        return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED);
    }

    @ApiOperation(
        value = "",nickname = "jobsPost",notes = "",response = Integer.class,message = "OK - Job Posted",response = Integer.class
)})
    @RequestMapping(
        value = {"/jobs"},consumes = {"multipart/form-data"},method = {RequestMethod.POST}
    )
    default ResponseEntity<Integer> jobsPost(@ApiParam("") @RequestPart(value = "name",required = false) String name,@ApiParam("") @Valid @RequestPart("file") MultipartFile file) {
        return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED);
    }
}

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。

相关推荐


使用本地python环境可以成功执行 import pandas as pd import matplotlib.pyplot as plt # 设置字体 plt.rcParams[&#39;font.sans-serif&#39;] = [&#39;SimHei&#39;] # 能正确显示负号 p
错误1:Request method ‘DELETE‘ not supported 错误还原:controller层有一个接口,访问该接口时报错:Request method ‘DELETE‘ not supported 错误原因:没有接收到前端传入的参数,修改为如下 参考 错误2:cannot r
错误1:启动docker镜像时报错:Error response from daemon: driver failed programming external connectivity on endpoint quirky_allen 解决方法:重启docker -&gt; systemctl r
错误1:private field ‘xxx‘ is never assigned 按Altʾnter快捷键,选择第2项 参考:https://blog.csdn.net/shi_hong_fei_hei/article/details/88814070 错误2:启动时报错,不能找到主启动类 #
报错如下,通过源不能下载,最后警告pip需升级版本 Requirement already satisfied: pip in c:\users\ychen\appdata\local\programs\python\python310\lib\site-packages (22.0.4) Coll
错误1:maven打包报错 错误还原:使用maven打包项目时报错如下 [ERROR] Failed to execute goal org.apache.maven.plugins:maven-resources-plugin:3.2.0:resources (default-resources)
错误1:服务调用时报错 服务消费者模块assess通过openFeign调用服务提供者模块hires 如下为服务提供者模块hires的控制层接口 @RestController @RequestMapping(&quot;/hires&quot;) public class FeignControl
错误1:运行项目后报如下错误 解决方案 报错2:Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:3.8.1:compile (default-compile) on project sb 解决方案:在pom.
参考 错误原因 过滤器或拦截器在生效时,redisTemplate还没有注入 解决方案:在注入容器时就生效 @Component //项目运行时就注入Spring容器 public class RedisBean { @Resource private RedisTemplate&lt;String
使用vite构建项目报错 C:\Users\ychen\work&gt;npm init @vitejs/app @vitejs/create-app is deprecated, use npm init vite instead C:\Users\ychen\AppData\Local\npm-
参考1 参考2 解决方案 # 点击安装源 协议选择 http:// 路径填写 mirrors.aliyun.com/centos/8.3.2011/BaseOS/x86_64/os URL类型 软件库URL 其他路径 # 版本 7 mirrors.aliyun.com/centos/7/os/x86
报错1 [root@slave1 data_mocker]# kafka-console-consumer.sh --bootstrap-server slave1:9092 --topic topic_db [2023-12-19 18:31:12,770] WARN [Consumer clie
错误1 # 重写数据 hive (edu)&gt; insert overwrite table dwd_trade_cart_add_inc &gt; select data.id, &gt; data.user_id, &gt; data.course_id, &gt; date_format(
错误1 hive (edu)&gt; insert into huanhuan values(1,&#39;haoge&#39;); Query ID = root_20240110071417_fe1517ad-3607-41f4-bdcf-d00b98ac443e Total jobs = 1
报错1:执行到如下就不执行了,没有显示Successfully registered new MBean. [root@slave1 bin]# /usr/local/software/flume-1.9.0/bin/flume-ng agent -n a1 -c /usr/local/softwa
虚拟及没有启动任何服务器查看jps会显示jps,如果没有显示任何东西 [root@slave2 ~]# jps 9647 Jps 解决方案 # 进入/tmp查看 [root@slave1 dfs]# cd /tmp [root@slave1 tmp]# ll 总用量 48 drwxr-xr-x. 2
报错1 hive&gt; show databases; OK Failed with exception java.io.IOException:java.lang.RuntimeException: Error in configuring object Time taken: 0.474 se
报错1 [root@localhost ~]# vim -bash: vim: 未找到命令 安装vim yum -y install vim* # 查看是否安装成功 [root@hadoop01 hadoop]# rpm -qa |grep vim vim-X11-7.4.629-8.el7_9.x
修改hadoop配置 vi /usr/local/software/hadoop-2.9.2/etc/hadoop/yarn-site.xml # 添加如下 &lt;configuration&gt; &lt;property&gt; &lt;name&gt;yarn.nodemanager.res