about the header parameter

[larssonsun]

hi, thanks for your proj:
how to add a parameter whitch the parameter's type is header，for exmaple
the accept header or some customize headers juest like token ?

[maximdanilchenko]

Hi!
There are several ways to do so.

1. If you need it for authentication - use securityDefinitions swagger param, like so:

setup_aiohttp_apispec(
        app,
        title='My API',
        version=__version__,
        info={"description": "some markdown description"},
        securityDefinitions={
            "user": {"type": "apiKey", "name": "Authorization", "in": "header"}
        },
)

It will add Authorization header in your documentation auth. Read more about it here. After that you can read headers from request.headers multidict.
2. If you need to add headers to some handler - use locations parameter, like so:

@use_kwargs(MyRequestSchema(strict=True), locations=['headers'])
async def my_handler(self, request: web.Request) -> web.Response:
    return web.Response()

After that you will see it in your documentation exactly for this method.
But as for now this way works not correctly with aiohttp_apispec.validation_middleware. It will update request['data'] dict with those headers. It can broke something if you have equal param names in your content and headers. So it is not recommended way. I want to fix this behavior someday.

[larssonsun]

thank you for your reply:
i just want to add api version into accpect header,
some like this:
Accept: vnd.example-com.foo+json; version=1.0

[maximdanilchenko]

setup_aiohttp_apispec(
        app,
        securityDefinitions={
            "user": {"type": "apiKey", "name": "Accept", "in": "header"}
        },
)

[larssonsun]

setup_aiohttp_apispec(
        app,
        securityDefinitions={
            "user": {"type": "apiKey", "name": "Accept", "in": "header"}
        },
)

sorry .but this solution can not make the request from swagger contain the accept header just like :
Accept: text/html; version=0.9

[larssonsun]

There are some extra consultations.
How to edit or add some comments and how to edit the parameter names with aiohttp-apispec?


💯

[maximdanilchenko]

Field description - use description argument in field.
Parameter name is the actual name of your parameter. You named it Version in your code, so the name in the docs will be Version.
If you want to add some text outside of methods description, you can use markdown like in my first comment in info["description"]

[maximdanilchenko]

@larssonsun I see that the question is answered, so I'm closing issue.

[khab-el]

setup_aiohttp_apispec(
        app,
        securityDefinitions={
            "user": {"type": "apiKey", "name": "Accept", "in": "header"}
        },
)

sorry .but this solution can not make the request from swagger contain the accept header just like : Accept: text/html; version=0.9

if you still need this feature, you have to add

setup_aiohttp_apispec(
        app,
        securityDefinitions={
            "user": {"type": "apiKey", "name": "Accept", "in": "header"}
         },
        security=[{"user": []}]
)