Support and examples for Class-Based Views (HTTPMethodView)

[fMeow]

Add support for Class-Based Views as issues #12 and #42 have pointed out.

In addition, a simple example is added to demonstrate that in class based view, sanic-openapi can actually work.

Examples for class-based views is also added to car examples.

[tudormunteanu]

Any idea when this will be merged in?

[anna-hope]

Is this adding something different than #67?

[fMeow]

You can install forked version via pip and see what's different. @notnami

I think that the main difference are examples and tags support for blueprint.

And I didn't notice that there had been some PR trying to provide class-based views support when I wrote my own solution.

[fMeow]

@tudormunteanu I think that sanic-openapi is no longer under maintenance. Besides, I need support for OpenAPI 3 for bearer token authentication. And that's why I turn to api-spec with some tricky code.
If anyone is interested, I can provide an example to show how to incorporate api-spec into sanic as it does not provide official support for sanic.

[ahopkins]

How is this different than #67? Do we need this still? Can we get rid of one of them?

[logileifs]

Can we get this pull request or 67 merged?
Is there something I can do to help? I could resolve the conflicts if that's the only thing keeping this from being merged

[ahopkins]

@chenjr0719 Can you take a look at these two and decide which one needs to be merged?

@logileifs The conflicts, but also understanding the overlap with #67.

move forward

[chenjr0719]

Looks great and verified with Sanic 19.3.1, everything works. But I'm afraid this PR is very behind to current master. There is no openapi.py in current master, not sure what would happen if we merge it.

[chenjr0719]

BTW, here is a replacement if we don't want to import HTTP_METHODS:

for http_method in route.methods

[fMeow]

I'm glad that this PR is receiving serious attention to bring class-based views to sanic-openapi. This PR has been around for a long time and may not match the current code of sanic-openapi.

So what can I help?

[chenjr0719]

@Guoli-Lyu Glad to have you back. After version 0.5.0, the openapi.py and swagger.py have been merged into one file. You can find exactly the same code snippet which you want to modify at current swagger.py.
https://github.com/huge-success/sanic-openapi/blob/f82af54c06ec1cb56d1e8ae361fa1ecc9656fe07/sanic_openapi/swagger.py#L78-L84
https://github.com/huge-success/sanic-openapi/blob/f82af54c06ec1cb56d1e8ae361fa1ecc9656fe07/sanic_openapi/swagger.py#L105-L106

So, what you have to do are:

1. Rebase your branch with current master.
2. Porting the changes you made from openapi.py to swagger.py.

If there is any problem, just let me know.

[fMeow]

Ok, I have done rebasing and porting. @chenjr0719

[chenjr0719]

Great, appreciate your awesome PR. @ahopkins This PR is ready to merge.

[fMeow]

What's the state of this PR? This PR have not merged yet.

[ahopkins]

@Guoli-Lyu Thanks for the nudge. I was waiting for the tests to complete and then forgot about it.

[junhoyeo]

Hope it update soon.

[ahopkins]

@junhoyeo what do you mean? it is merged.

[chenjr0719]

@ahopkins I think what @junhoyeo talking about is to publish a new release on PyPI.