search

python-restx / flask-restx

Fork of Flask-RESTPlus: Fully featured framework for fast, easy and documented API development with Flask
https://flask-restx.readthedocs.io/en/latest/
Other
2.16k stars 335 forks source link

Flask-RestX v1.0.5 & breathing new life into this project! #510

Open peter-doggart opened 1 year ago

peter-doggart commented 1 year ago

Afternoon flask-restx community!

With thanks to @jdieter and @ziirish all the compatibility warnings with flask 2.3 should be gone in flask-restx v1.0.5 which I have just released (hopefully :crossed_fingers:)! If not, please open an issue and let me know!

Aside from keeping up to date with upstream changes in flask and general maintenance, I would like to breathe some new life into this project.

With that in mind, I would like to ask you, the community, who use this project, what your top priorities for bug fixes and new features or changes are. Big or small, things that don't work or things that you just don't like. I can't promise I will have time to fix or implement all of them, but I do promise to read every suggestion and engage with you. I will also make an effort to review and integrate PRs, so if anyone wants to become a contributor, I would encourage you to do so!

Anything related to model redesign can go over on #59, but for anything else, please comment below.

beautah commented 1 year ago

Just couldn't help myself and had to drop a note to thank all the contributors for this release, I just upgraded (from something like 0.5) and everything is faster with zero pain - zero breaking changes and running a modern flask version. Kudos, so much kudos. I have several projects I was dreading migrating from flask-restplus/restx.

davidjb99 commented 1 year ago

Thank you for taking over this project @peter-doggart this is a great framework and I’ve enjoyed using it for some time.

I think better support for OpenAPI generation would be most welcome.

peter-doggart commented 1 year ago

@davidjb99 Thanks for your feedback. In terms of better support for OpenAPI generation, what would you like to see going forwards? Obviously, support for OpenAPI v3 has been suggested for a long time, but is there anything else in terms of customization or support you think would be useful?

PanderMusubi commented 1 year ago

According to https://pypi.org/project/flask-restx/#history there is also a version 1.1.0 However, that is not yet published here on GitHub.

peter-doggart commented 1 year ago

@PanderMusubi Fixed that now. I must have forgotten to do it. It's the only part of the release pipeline that isn't automated by github actions currently.

cyrlop commented 1 year ago

Thanks for the great work!

I would like to ask you, the community, who use this project, what your top priorities for bug fixes and new features

For me the top priority is #26 :smiley: (is support for v2 needed?)

lcdunne commented 1 year ago

Hi, I've just discovered Flask-RestX and really like that it is being revived!

The primary thing that stands out to me is the Open API support. Is there a roadmap somewhere for this? I saw the Issue #26, but it seems unclear where the progress currently is.

In my opinion the Flask ecosystem is really in need of an extension that can provide automatic Open API 3 documentation. A big bonus would be to accomplish this with something like Pydantic (as discussed in #26 ), though that's just a nice-to-have.

Looking forward to learning a bit about RestX and following the progress.

thedumbterminal commented 1 year ago

Hi, great news! I've been waiting a while to get the following PR reviewed: https://github.com/python-restx/flask-restx/pull/442 which resolves this issue: https://github.com/python-restx/flask-restx/issues/438

Let me know if I need to do any changes.

Thanks in advance

rlleshi commented 1 year ago

Hello @peter-doggart. I haven't noticed so much progress so far so I was wondering if you are still planning to maintain this project.

peter-doggart commented 1 year ago

@rlleshi Yes, but mostly only for maintenance (keeping up with flask releases etc) currently due to time constraints and the fact that a lot of the project is stable.

Reviewing outstanding PRs is still on my to-do list. The issue is there are so many to get through and I want to make sure we don't accidentally break anything in the process!

OpenAPI v3 support and other major changes that go deep into flask-restx are unlikely in the short term though.

MajorDallas commented 1 year ago

I'm just catching up--glad to hear that this library is picking up some steam again! But yikes, I'm still pinned to 0.5.0...

As long as we're making suggestions, I have a crazy one and I don't expect anything to come of it... My big pain point with flask-restx in the last few months has been that it's too easy for the generated swagger and the actual code behavior to drift apart. And yes, I do realize this is primarily programmer error (i.e. my own damn fault 😝), but, that said, I find myself wishing for more powerful validation that what I say the API is going to do and what it does still match up after a refactor. At one point I was working to transition to Connexion since it raises an exception when an endpoint returns something that doesn't exactly match what is defined in the schema, but I decided to wait because it sounds like they're getting close to a major release and I didn't want to rewrite twice.

I'll also acknowledge it's very possible flask-restx has more powerful validation tooling already and I simply missed it or misunderstood it. I know it's pretty good at validating requests, but responses..?

abompard commented 3 months ago

OpenAPI v3 support and other major changes that go deep into flask-restx are unlikely in the short term though.

No hard commitment, but if I were to send a PR to add OpenAPI v3 support to flask-restx, would you review and consider it @peter-doggart ? Or would you rather see it done by someone from the "core team" or yourself? (which I can totally understand, it's more work to review a newcomer's PR)

terryluan12 commented 2 months ago

OpenAPI v3 support and other major changes that go deep into flask-restx are unlikely in the short term though.

No hard commitment, but if I were to send a PR to add OpenAPI v3 support to flask-restx, would you review and consider it @peter-doggart ? Or would you rather see it done by someone from the "core team" or yourself? (which I can totally understand, it's more work to review a newcomer's PR)

Just bumping this! Also would definitely be willing to help with this endeavor