spec-first/connexion

Allow passing of a Specification object to AbstractApp.add_api

Open

#1,260 opened on Jun 26, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (4,346 stars) (738 forks)batch import
enhancementgood first issue

Description

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
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic Python knowledgeFamiliarity with connexion library
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
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.
Allow passing of a Specification object to AbstractApp.add_api · spec-first/connexion#1260 | Good First Issue