sanic-openapi and sanic-jwt

[saeedghx68]

I use sanic-openapi and sanic-jwt
How to set @doc.consumes and @doc.produces for below API's of sanic-jwt

POST/auth/
GET/auth/me/
GET/auth/verify/

[saeedghx68]

I implement by this code

from sanic_jwt.endpoints  import AuthenticateEndpoint
from sanic_openapi import doc

class LoginSwDoc:
    username = doc.String("Username", required=True)
    password = doc.String("Password", required=True)

# add swagger doc to sanic JWT method
AuthenticateEndpoint.decorators.extend([
    doc.summary("Authenticate user and get token"),
    doc.consumes(LoginSwDoc, location='body'),
    doc.produces(LoginSwDoc),
    doc.consumes({'AUTHORIZATION': str}, location='header'),
])

[nomed]

Hi,

tried on sanic 20.9.0 with no success.

Is it supposed to work also on more recent releases ?

[digitalkaoz]

this was my attempt:

def document_auth_bp():
    from sanic_jwt.endpoints import RetrieveUserEndpoint, AuthenticateEndpoint, VerifyEndpoint, RefreshEndpoint

    inner_me = RetrieveUserEndpoint.get

    @doc.summary("returns the user for this JWT Token")
    @doc.consumes({'AUTHORIZATION': str}, location='header')
    @doc.produces(User)
    async def doc_me(self, request, *args, **kwargs):
        return await inner_me(self, request, *args, **kwargs)

    RetrieveUserEndpoint.get = doc_me

    inner_auth = AuthenticateEndpoint.post

    @doc.summary("login a user")
    @doc.consumes(doc.JsonBody({
        "username": doc.String("the username"),
        "password": doc.String("the password"),
    }), location="body")
    @doc.response(401, None, description="invalid credentials")
    @doc.response(200, {"access_token": str, "refresh_token": str}, description="the token to use for api interaction")
    async def doc_auth(self, request, *args, **kwargs):
        return await inner_auth(self, request, *args, **kwargs)

    AuthenticateEndpoint.post = doc_auth

    inner_verify = VerifyEndpoint.get

    @doc.summary("verifies a JWT")
    @doc.consumes({'AUTHORIZATION': str}, location='header')
    @doc.response(401, None, description="Token is invalid or expired")
    @doc.response(200, {"valid": True}, description="Token is valid")
    async def doc_verify(self, request, *args, **kwargs):
        return await inner_verify(self, request, *args, **kwargs)

    VerifyEndpoint.get = doc_verify

    inner_refresh = RefreshEndpoint.post

    @doc.summary("generates a new access token with the refresh token")
    @doc.consumes({'AUTHORIZATION': str}, location='header')
    @doc.consumes(doc.JsonBody({
        "refresh_token": doc.String("the refresh token"),
    }), location="body")
    @doc.response(401, None, description="Token is invalid or expired")
    @doc.response(200, {"access_token": str}, description="the new access token")
    async def doc_refresh(self, request, *args, **kwargs):
        return await inner_refresh(self, request, *args, **kwargs)

    RefreshEndpoint.post = doc_refresh

document_auth_bp()

jwt = Initialize(
    app,
    ...
)

i feel pretty dirty right now, but it works, would love to see a cleaner solution!

@nomed

[quadhead]

My solution:

sanicjwt = Initialize(
    app,
    ...
)

for route in sanicjwt.bp.routes:
    view = route.handler.view_class
    for http_method in route.methods:
        h = getattr(view, http_method.lower(), None)
        if h:
            name = route.handler.__name__
            d = doc.route_specs[h]
            if name == "AuthenticateEndpoint":
                d.summary = "Authenticate user and get token"
            if name == "RetrieveUserEndpoint":
                d.summary = "Retrieve current user"
            if name == "VerifyEndpoint":
                d.summary = "Verify token"
            if name == "RefreshEndpoint":
                d.summary = "Generate new token using refresh token"

Seems a little bit more elegant...