Module backend::config::api_doc

source ยท
Expand description

Contains code to generate OpenApi documentation and a Swagger endpoint using utoipa and utoipa_swagger_ui.

Structsยง

  • Struct used by utoipa to generate OpenApi documentation for all plantings endpoints.
  • BlossomsApiDoc ๐Ÿ”’
    Struct used by utoipa to generate OpenApi documentation for all blossom endpoints.
  • ConfigApiDoc ๐Ÿ”’
    Struct used by utoipa to generate OpenApi documentation for all config endpoints.
  • DrawingsApiDoc ๐Ÿ”’
    Struct used by utoipa to generate OpenApi documentation for drawings endpoints.
  • GuidedToursApiDoc ๐Ÿ”’
    Struct used by utoipa to generate OpenApi documentation for all guided tours endpoints.
  • LayerApiDoc ๐Ÿ”’
    Struct used by utoipa to generate OpenApi documentation for all layer endpoints.
  • MapApiDoc ๐Ÿ”’
    Struct used by utoipa to generate OpenApi documentation for all map endpoints.
  • PlantLayerApiDoc ๐Ÿ”’
    Struct used by utoipa to generate OpenApi documentation for all plant layer endpoints.
  • PlantingsApiDoc ๐Ÿ”’
    Struct used by utoipa to generate OpenApi documentation for all plantings endpoints.
  • PlantsApiDoc ๐Ÿ”’
    Struct used by utoipa to generate OpenApi documentation for all plant endpoints.
  • SecurityAddon ๐Ÿ”’
    Used by utoipa for OAuth2.
  • SeedApiDoc ๐Ÿ”’
    Struct used by utoipa to generate OpenApi documentation for all seed endpoints.
  • TimelineApiDoc ๐Ÿ”’
    Struct used by utoipa to generate OpenApi documentation for all timeline endpoints.
  • UsersApiDoc ๐Ÿ”’
    Struct used by utoipa to generate OpenApi documentation for all user data endpoints.

Functionsยง

  • Merges OpenApi and then serves it using Swagger.