feat: OpenAPI integration

[NexVeridian]

related #855

cargo check -F all_openapi
cargo nextest run --test-threads 1 -F all_openapi

TODO:

• config.yaml
  • maybe no enable: true since that's handled by the feature

    openapi:
      redoc:
        !Redoc
          url: /redoc
          spec_json_url: /redoc/openapi.json
          spec_yaml_url: /redoc/openapi.yaml
      scalar:
        !Scalar
          url: /scalar
          spec_json_url: /scalar/openapi.json
          spec_yaml_url: /scalar/openapi.yaml
      swagger:
        !Swagger
          url: /swagger-ui
          spec_json_url: /api-docs/openapi.json
          spec_yaml_url: /api-docs/openapi.yaml

  • finish .merge(Redoc::with_url("/redoc", api.clone()))
  • openapi.josn and openapi.yaml endpoints for all types
• split feature openapi into feature all_openapi swagger-ui redoc scalar
• rstest feature flagged cases
• SecurityAddon
  • put impl Modify for SecurityAddon somewhere, maybe with config
  • set the jwt token location
• tests
  • update src/tests_cfg/db.rs:86:1
  • src/tests_cfg/config.rs
  • config from file test_from_folder_openapi()
  • snapshots
• docs
• codegen/document adding #[derive[utoipa::ToSchema)] if used in utoipa::path
cargo loco generate controller --openapi
• maybe auto fill / wrap utoipa::path if possible
• check that get in get(get_action_openapi) is still grabbed with routes!(get_action_openapi)
• fix AppContext - check that api_router.routes(method.with_state::<AppContext>(())) doesn't break the ctx with .layer
• cargo test is broken with JWT_LOCATION.get_or_init, nextest works correctly

cc @DenuxPlays

[DenuxPlays]

Looks like a good start.

I think the yaml also should contain a few other things:

• openapi and ui endpoints (I am not sure if this is want you mean in your description)
• whether it serves json, yaml or both (Perhaps this can be controlled by using features to exclude unnecessary dependencies)

[DenuxPlays]

Hey @NexVeridian

Can I help you finish this pr?

[NexVeridian]

@DenuxPlays yeah of course

[DenuxPlays]

How can I help?

Also just one Note to your pr description.
I wouldn't wrap the utoipa path macro.
Its working very well just how it is and wrapping it would make upgrading and maintaining very difficult

[NexVeridian]

Also just one Note to your pr description. I wouldn't wrap the utoipa path macro. Its working very well just how it is and wrapping it would make upgrading and maintaining very difficult

thanks!

this would be nice if possible:

impl Routes {
/// .add_openapi(routes!(get_action, post_action))
pub fn add_openapi(mut self, method: UtoipaMethodRouter<AppContext>) -> Self {}
}

any of the unchecked ones in the pr description would be great:
maybe cargo loco generate controller --openapi and docs first