mirror of
https://github.com/LukeHagar/connexion.git
synced 2025-12-09 12:27:46 +00:00
edb0381af3
This PR adds an interface for the ConnexionMiddleware, similar to the
interface of the Connexion Apps.
The Connexion Apps are now a simple wrapper around the
ConnexionMiddleware and framework app, delegating the work to the
middleware. This enables a similar interface and behavior for users when
using either the middleware or apps.
The arguments are repeated everywhere there is a user interface, but are
parsed in a central place. Repeating the arguments is not DRY, but
needed to provide users with IDE autocomplete, typing, etc. They are
parsed in a single `_Options` class, which also provides a mechanism to
set default options on an App level, and override them on the more
granular API level.
This makes the long list of provided parameters a lot more manageable,
so I would like to use it for the `Jsonifier` as well, and re-add the
`debug` and `extra_files` arguments which I have dropped in previous
PRs. I'll submit a separate PR for this.
I renamed the `options` parameter to `swagger_ui_options` since it only
contains swagger UI options. This is a breaking change though, and we'll
need to highlight this upon release.
We still have quite a lot of `App`, `MiddlewareApp`, and abstract
classes. It would be great if we could find a way to reduce those
further, or at least find better naming to make it more clear what each
one does 🙂 .
Finally, I added examples on how the middleware can be used with third
party frameworks under `examples/frameworks`. Currently there's an
example for Starlette and Quart, but this should be easy to extend. They
also show how the `ASGIDecorator` and `StarletteDecorator` from my
previous PR can be used.
39 lines
819 B
YAML
39 lines
819 B
YAML
openapi: "3.0.0"
|
|
|
|
info:
|
|
title: Hello World
|
|
version: "1.0"
|
|
servers:
|
|
- url: /openapi
|
|
|
|
paths:
|
|
/greeting/{name}:
|
|
post:
|
|
summary: Generate greeting
|
|
description: Generates a greeting message.
|
|
operationId: post_greeting
|
|
responses:
|
|
200:
|
|
description: greeting response
|
|
content:
|
|
text/plain:
|
|
schema:
|
|
type: string
|
|
example: "hello dave!"
|
|
parameters:
|
|
- name: name
|
|
in: path
|
|
description: Name of the person to greet.
|
|
required: true
|
|
schema:
|
|
type: string
|
|
example: "dave"
|
|
- name: number
|
|
in: query
|
|
description: A number.
|
|
schema:
|
|
type: integer
|
|
example: 1
|
|
default: 0
|
|
|