Code-generation of type hints and handler interfaces

Ouverte
#376 3 commentaires 3 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
5/5
Temps estimé
Plus d'une semaine
Accessibilité débutants
25/100
Type d'issue
Fonctionnalité
Clarté
À clarifier
Activité
À l'abandon
Stack technique
openapi, python
Domaine
api, backend-api-design

Piste de recherche

Start by reviewing the issue’s proposed comparisons with oapi-codegen and fastapi-code-generator, then identify which supported web frameworks and OpenAPI data need interfaces. The work is done when the project has an agreed design and generated type hints and request-handler interfaces that cover validated request bodies, URL parameters, and headers.

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

Description

Something still missing in all OpenAPI-first implementations I've seen for Python including openapi-core is type-safety w.r.t. the validated request body, URL parameters, and headers. openapi-core validates this data, but there currently is no way to statically type it except for manually implementing the type hints and manually typing the request handlers. This is brittle and doesn't scale well.

I suggest to generate code containing type hints and request handler interfaces for the supported web frameworks similar to oapi-codegen (Golang) or fastapi-code-generator (Python).

The details need to be discussed and figured out, of course, but I'd appreciate some feedback first. What do you think?

Langage dominant
Python
Étoiles
368
Forks
140
Aucune PR mergée en 30 j

Guide de contribution

Ouvrir le guide de contribution

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 python-openapi/openapi-core

Toutes les issues de python-openapi/openapi-core

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

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