Add a single-file example #9
Conversation
zupo
force-pushed
the
add/singlefile-example
branch
4 times, most recently
from
f219bf1 to
276caac
Compare
| @@ -59,6 +59,7 @@ def wrapper_view(context, request): | |||
| ) | |||
| else: | |||
| # Do the view | |||
| request.openapi_validated.raise_for_errors() | |||
There was a problem hiding this comment.
If the _pyramid_openapi3_validation_view_name view is not configured, we shouldn't just silently swallow validation errors and continue, but raise the appropriate validation exception.
| @@ -151,7 +152,6 @@ def spec_view(request): | |||
|
|
|||
| config.add_route(route_name, route) | |||
| config.add_view(route_name=route_name, view=spec_view) | |||
| config.add_view(route_name=route_name, view=spec_view) | |||
There was a problem hiding this comment.
Probably leftover of a rebase gone wrong.
zupo
force-pushed
the
add/singlefile-example
branch
from
276caac to
c09b4bb
Compare
| if __name__ == "__main__": | ||
| """If app.py is called directly, start up the app.""" | ||
| with tempfile.NamedTemporaryFile() as document: | ||
| document.write(OPENAPI_DOCUMENT) |
There was a problem hiding this comment.
Swagger client examples require the path to JSON spec https://github.com/swagger-api/swagger-js#import-in-browser. I think is better to expose JSON and yaml as routes, so that it can actually be used.
There was a problem hiding this comment.
pyramid_openapi3 takes care of publishing the YAML file:
I double checked, and the try-me examples seem to work:
Or am I misunderstanding what you are trying to say?
There was a problem hiding this comment.
I was thinking if you use API outside of the API explorer.
There was a problem hiding this comment.
So, to convert YAML into JSON and publish both?
There was a problem hiding this comment.
Yep, so add another handler for JSON request like for yaml
https://github.com/niteoweb/pyramid_openapi3/blob/master/pyramid_openapi3/__init__.py#L133
And then the example in https://github.com/swagger-api/swagger-js#in-browser should be valid.
There was a problem hiding this comment.
That's completely out of the scope of this PR.
No description provided.