spec-first/connexion

Allow passing of a Specification object to AbstractApp.add_api

Open

#1,260 建立於 2020年6月26日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)Python (4,346 star) (738 fork)batch import
enhancementgood first issue

描述

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.

貢獻者指南

技術棧
python
領域
backendapi
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Basic Python knowledgeFamiliarity with connexion library
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60
研究方向
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.