route parameter not found about flask-openapi3

[luolingchun]

Can you paste a simple scripts to show this problem?

[DerManoMann]

Ok, here is a simple example.

There is a number of subtle changes to change the behavior:

• As is:
  • I get TypeError: hello() missing 1 required positional argument: 'path'
  • I get No operations defined in spec! in swagger UI
• adding =None to hello => def hello(name, path: PathName=None):
• Endpont works
• I get No operations defined in spec! in swagger UI
• changing @bp.route to @bp.get
  • I get TypeError: hello() missing 1 required positional argument: 'path'
  • swagger UI shows endpoint as expected

Hope that makes sense and helps :)

Cheers, mano

from flask_openapi3 import OpenAPI, APIBlueprint
from flask_openapi3.models import Info
from pydantic import BaseModel, Field

app = OpenAPI(__name__, info=Info(title="Hello API", version="1.0.0"),)

bp = APIBlueprint("Hello BP", __name__)

class PathName(BaseModel):
    name: str = Field(..., description="The name")

@bp.route("/hello/<string:name>")
def hello(name, path: PathName):
    return f"""Hello {name}!"""

app.register_api(bp)

if __name__ == "__main__":
    app.run()

[luolingchun]

The endpoint can only take six parameters. They are path, query, form, body, header, cookie, more information go to the docs.

so you should use it like this:

...

@bp.route("/hello/<string:name>")
def hello(path: PathName):
    name = path.name
    return f"""Hello {name}!"""

...

[DerManoMann]

Cool, that makes sense. Somehow this wasn't entirely clear to me.

Thanks.