[python-fastapi][REQ] Add `Fastapi Request` parameter to api methods

Ouverte Adaptée aux débutants
#25,753 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
70/100
Type d'issue
Fonctionnalité
Clarté
Clairement spécifiée
Activité
Active
Stack technique
fastapi, openapi, python

Piste de recherche

Commence par lire api.mustache et base_api.mustache dans les templates du générateur python-fastapi, ainsi que la documentation FastAPI Request liée dans l'issue. Régénère un petit exemple FastAPI pour voir comment les endpoints et les méthodes de base sont émis, puis ajoute le paramètre Request aux deux signatures de template et transmets-le à l'implémentation. Terminé lorsque les endpoints générés acceptent et relaient Request, et que l'exemple/les tests python-fastapi du générateur passent toujours le build.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

Enhancement: Feature
Need Fastapi Request in the implementation of the api

As the Fastapi documentation says here it would be good to have access to the request object in the implementation of the api.

Modify api.moustache and base_api.moustache

Add the request to the method in the moustache files, e.g.

async def {{operationId}}(
    request: Request,
    {{#allParams}}
    {{>endpoint_argument_definition}},
    {{/allParams}}
    {{#hasAuthMethods}}
    {{#authMethods}}
    token_{{name}}: TokenModel = Security(
        get_token_{{name}}{{#isOAuth}}, scopes=[{{#scopes}}"{{scope}}"{{^-last}}, {{/-last}}{{/scopes}}]{{/isOAuth}}
    ),
    {{/authMethods}}
    {{/hasAuthMethods}}
) -> {{returnType}}{{^returnType}}None{{/returnType}}:
    {{#notes}}"""{{.}}"""
    {{/notes}}if not Base{{classname}}.subclasses:
        raise HTTPException(status_code=500, detail="Not implemented")
    return await Base{{classname}}.subclasses[0]().{{operationId}}(request, {{#allParams}}{{>impl_argument}}{{^-last}}, {{/-last}}{{/allParams}})
{{^-last}}
class Base{{classname}}:
    subclasses: ClassVar[Tuple] = ()

    def __init_subclass__(cls, **kwargs):
        super().__init_subclass__(**kwargs)
        Base{{classname}}.subclasses = Base{{classname}}.subclasses + (cls,)
{{#operations}}
{{#operation}}
    async def {{operationId}}(
        self,
        request: Request,
        {{#allParams}}
        {{>impl_argument_definition}},
        {{/allParams}}
    ) -> {{returnType}}{{^returnType}}None{{/returnType}}:
        {{#notes}}"""{{.}}"""
        ...{{/notes}}{{^notes}}...{{/notes}}
Langage dominant
Java
Étoiles
26.9k
Forks
7.8k
Merge moyen
2 j 23 min
PR mergées (30 j)
177

Préparer son environnement

Ouvrir dans Codespaces

Lance le conteneur de développement du projet dans votre navigateur, avec votre propre compte GitHub.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de OpenAPITools/openapi-generator

Toutes les issues de OpenAPITools/openapi-generator

Issues similaires

Plus d'issues Java

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.