Module api_doc

Source
Expand description

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

Structsยง

AreasApiDoc ๐Ÿ”’
Struct used by utoipa to generate OpenApi documentation for all area endpoints.
BaseLayerImagesApiDoc ๐Ÿ”’
Struct used by utoipa to generate OpenApi documentation for all base_layer_image endpoints.
BlossomsApiDoc ๐Ÿ”’
Struct used by utoipa to generate OpenApi documentation for all blossoms endpoints.
ConfigApiDoc ๐Ÿ”’
Struct used by utoipa to generate OpenApi documentation for all config endpoints.
DrawingsApiDoc ๐Ÿ”’
Struct used by utoipa to generate OpenApi documentation for all 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 layers endpoints.
MapApiDoc ๐Ÿ”’
Struct used by utoipa to generate OpenApi documentation for all map endpoints.
MapCollaboratorsApiDoc ๐Ÿ”’
struct used by utoipa to generate openapi documentation for all map_collaborators 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 plants 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 users endpoints.

Functionsยง

config
Merges OpenApi and then serves it using Swagger.