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

Aperta Adatta ai principianti
#25,753 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
70/100
Tipo di issue
Funzionalità
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
fastapi, openapi, python

Direzione di ricerca

Inizia leggendo api.mustache e base_api.mustache nei template del generatore python-fastapi, insieme alla documentazione di FastAPI Request collegata nell'issue. Rigenera un piccolo esempio FastAPI per vedere come vengono emessi gli endpoint e i metodi base, poi aggiungi il parametro Request a entrambe le firme dei template e passalo all'implementazione. Fatto quando gli endpoint generati accettano e inoltrano Request, e l'esempio/i test python-fastapi del generatore continuano a compilare.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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}}
Lingua principale
Java
Stelle
26.9k
Fork
7.8k
Merge medio
2g 23m
PR unite (30g)
177

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di OpenAPITools/openapi-generator

Tutte le issue di OpenAPITools/openapi-generator

Issue simili

Altre issue su Java

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.