Adding support for AWS Chalice framework

marshmallow-code / apispec-webframeworks

Web framework plugins for apispec (formally in apispec.ext).

MIT License

32 stars 23 forks source link

Adding support for AWS Chalice framework #80

Closed treidel closed 4 years ago

treidel commented 4 years ago

I've written a path plugin for the AWS Chalice framework to make it a bit easier to create a specification using Chalice path routes.

elfjes commented 4 years ago

@sloria What do you think about supporting additional frameworks? I guess this one, being backed by Amazon, is not prone to disappear quickly.

From my first impression, code-wise I have the following remarks:

The comments are redundant, they just describe the code.
Can't use f-strings (unfortunately) as Python 3.5 is still supported
The whole nested if structure in ChalicePlugin._route_for_view looks like it should be refactored to reduce nesting

But let's first wait to see if other frameworks are to be supported :)

Also: whats up with the CI, why is it not running? Is that due to the merge conflicts with master?

sloria commented 4 years ago

As I mentioned in https://github.com/marshmallow-code/apispec/issues/157, I'd rather see this released as a separate package and added it to this list. This project is currently in a sort of maintenance mode, and adding support for frameworks increases the maintenance burden.

treidel commented 4 years ago

@sloria @elfjes Thanks for looking at this. I don't have the bandwith create a separate package for this as the project I'm using apispec for is a personal itch I'm scratching. It would more maintenance for me to make this it's own package which is time I can't spend at the moment. FWIW I think this is why the previous apispec-chalice package was abandoned and no longer works.

It was only marginally useful to have a path helper for my framework and I ended up writing the code to populate apispec with my REST endpoints programmatically. So I'm happy to leave this where it is..