Send data via header using OpenApi 3 with method GET

Question

Hello!Would anyone know how to help me send data via header using the get method in OpenApi 3?Code that doesn't work:&nbsp;/version:get:&nbsp; &nbsp; tags:&nbsp; &nbsp; - "version"&nbsp; &nbsp; summary: ""&nbsp; &nbsp; description: ""&nbsp; &nbsp; parameters:&nbsp; &nbsp; - name: "Content-Type"&nbsp; &nbsp; &nbsp; in: "header"&nbsp; &nbsp; &nbsp; description: ""&nbsp; &nbsp; &nbsp; required: true&nbsp; &nbsp; &nbsp; content:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; application / xml:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; schema:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; type: string&nbsp;In version 2 I can do it well.working code:&nbsp;get:&nbsp; &nbsp; tags:&nbsp; &nbsp; - "version"&nbsp; &nbsp; summary: ""&nbsp; &nbsp; description: ""&nbsp; &nbsp; produces:&nbsp; &nbsp; - "application / xml"&nbsp; &nbsp; parameters:&nbsp; &nbsp; - name: "Content-Type"&nbsp; &nbsp; &nbsp; in: "header"&nbsp; &nbsp; &nbsp; description: ""&nbsp; &nbsp; &nbsp; required: true&nbsp; &nbsp; &nbsp; type: "string"&nbsp; &nbsp; responses:&nbsp; &nbsp; &nbsp; &nbsp; "200":&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; description: "successful operation"&nbsp; &nbsp; &nbsp; &nbsp; "400":&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; description: "Invalid status value"

hkosova · Answer

Hi&nbsp;vitorlima1602,
Can you please clarify why you need the Content-Type header in a GET request? Content-Type is used in requests that have a request body, such as POST, PUT, or PATCH. GET requests are not supposed to have a body, this is explicitly disallowed in OpenAPI 3.0.

vitorlima1602 · Answer

Hi.It is that in the company where I work, they adopted a standard of trafficking data through the header, including several GET methods are working like this, people test via postman and it works normally.Now they want to use the swagger accessing the routes in the same way and I don't know how to do that.

hkosova · Answer

You can have header parameters, just not the ones named Content-Type or Accept - these headers are derived from request and response media types. Check out the Describing Parameters guide, it has some examples.

Forum Discussion

Send data via header using OpenApi 3 with method GET

Related Content

Defining conditional attributes in OpenAPI

DELETE Method Without Content-Type Header?

c# openapi parameter schema object

Sub Tags Option in OpenAPI 3.0

Missing header

Recent Discussions

Swagger UI rendering issues

Validate different http codes using different requests to the same endpoint in OpenAPI 3

Validating endpoint response by types

Swagger UI - Documentation for end user?

Reusable nullable enums?