spec-first/connexion

Allow passing of a Specification object to AbstractApp.add_api

Open

#1.260 geöffnet am 26. Juni 2020

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (4.346 Stars) (738 Forks)batch import
enhancementgood first issue

Beschreibung

Description

Right now you can pass either a file path to a JSON swagger spec, or a parsed dictionary of one.

Expected behaviour

It would be nice if you could pass in a Specification object, since they can be quite expensive to create even from a dictionary - as much as 10s for ours! Enabling this could speed up startup times for large apps, as well as aid in testing where apps are created over and over.

Actual behaviour

It doesn't do allow this :) People instead monkeypatch (eg. https://github.com/zalando/connexion/issues/306#issuecomment-584258868) to work around this which is never ideal.

Contributor Guide

Tech Stack
python
Domain
backendapi
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Basic Python knowledgeFamiliarity with connexion library
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60
Research-Richtung
Examine the current implementation of `AbstractApp.add api` in the connexion source code, likely in `connexion/app.py`. Understand how it currently accepts a file path or dict. Determine the structure of a `Specification` object and modify the method to accept it as an alternative input, handling the creation path accordingly. Test the change with examples from the issue.