backend/config/

api_doc.rs

//! Contains code to generate `OpenApi` documentation and a `Swagger` endpoint using [`utoipa`] and [`utoipa_swagger_ui`].

#![allow(clippy::needless_for_each)]

use actix_web::web;
use utoipa::{
    openapi::security::{AuthorizationCode, Flow, OAuth2, Scopes, SecurityScheme},
    Modify, OpenApi,
};
use utoipa_swagger_ui::SwaggerUi;

use crate::{
    config::auth::Config,
    controller::{
        areas, base_layer_image, config, drawings, guided_tour, layers, map, map_collaborators,
        plant_layer, plantings, plants, seed, timeline, users,
    },
    keycloak_api,
    model::{
        dto::{
            areas::{
                AreaDto, AreaKind, NewAreaDto, UpdateAddDateAreaDto, UpdateAreaDto,
                UpdateRemoveDateAreaDto,
            },
            base_layer_images::{BaseLayerImageDto, UpdateBaseLayerImageDto},
            core::{
                ActionDtoWrapperDeleteDrawings, ActionDtoWrapperDeleteLayer,
                ActionDtoWrapperDeletePlantings, ActionDtoWrapperNewDrawings,
                ActionDtoWrapperNewLayer, ActionDtoWrapperNewPlantings,
                ActionDtoWrapperUpdateDrawings, ActionDtoWrapperUpdateLayer,
                ActionDtoWrapperUpdatePlantings, TimelinePagePlantingsDto,
            },
            drawings::{
                DrawingDto, EllipseProperties, FreeLineProperties, ImageProperties,
                LabelTextProperties, PolygonProperties, RectangleProperties,
                UpdateAddDateDrawingDto, UpdateNotesDrawingDto, UpdateRemoveDateDrawingDto,
            },
            layers::LayerDto,
            plantings::{
                MovePlantingDto, PlantingDto, TransformPlantingDto, UpdateAddDatePlantingDto,
                UpdatePlantingDto, UpdatePlantingNoteDto, UpdateRemoveDatePlantingDto,
            },
            timeline::{TimelineDto, TimelineEntryDto},
            CompleteGuidedTourStepDto, CompleteGuidedTourStepsDto, ConfigDto, Coordinates,
            DeleteMapCollaboratorDto, GuidedTourDto, MapCollaboratorDto, MapDto,
            NewMapCollaboratorDto, NewMapDto, NewSeedDto, PageLayerDto, PageMapDto,
            PagePlantsSummaryDto, PageSeedDto, PlantsSummaryDto, RelationDto, RelationsDto,
            SeedDto, UpdateMapDto,
        },
        r#enum::{
            privacy_access_control::PrivacyAccessControl, quality::Quality, quantity::Quantity,
            shade::Shade, spatial_relation_type::SpatialRelationType,
        },
    },
};

/// Struct used by [`utoipa`] to generate `OpenApi` documentation for all [`mod@config`] endpoints.
#[derive(OpenApi)]
#[openapi(paths(config::get), components(schemas(ConfigDto)))]
struct ConfigApiDoc;

/// Struct used by [`utoipa`] to generate `OpenApi` documentation for all [`mod@seed`] endpoints.
#[derive(OpenApi)]
#[openapi(
    paths(
        seed::find,
        seed::find_by_id,
        seed::create,
        seed::delete_by_id
    ),
    components(
        schemas(
            PageSeedDto,
            SeedDto,
            NewSeedDto,
            Quality,
            Quantity
        )
    ),
    modifiers(&SecurityAddon)
)]
struct SeedApiDoc;

/// Struct used by [`utoipa`] to generate `OpenApi` documentation for all [`mod@plants`] endpoints.
#[derive(OpenApi)]
#[openapi(
    paths(
        plants::find,
        plants::find_by_id
    ),
    components(
        schemas(
            PagePlantsSummaryDto,
            PlantsSummaryDto
        )
    ),
    modifiers(&SecurityAddon)
)]
struct PlantsApiDoc;

/// Struct used by [`utoipa`] to generate `OpenApi` documentation for all [`mod@map`] endpoints.
#[derive(OpenApi)]
#[openapi(
    paths(
        map::find,
        map::find_by_id,
        map::create,
        map::update
    ),
    components(
        schemas(
            PageMapDto,
            MapDto,
            NewMapDto,
            UpdateMapDto,
            PrivacyAccessControl,
            Coordinates
        )
    ),
    modifiers(&SecurityAddon)
)]
struct MapApiDoc;

/// Struct used by [`utoipa`] to generate `OpenApi` documentation for all [`mod@layers`] endpoints.
#[derive(OpenApi)]
#[openapi(
    paths(
        layers::find,
        layers::find_by_id,
        layers::create,
        layers::delete
    ),
    components(
        schemas(
            LayerDto,
            PageLayerDto,
            ActionDtoWrapperNewLayer,
            ActionDtoWrapperUpdateLayer,
            ActionDtoWrapperDeleteLayer,
        )
    ),
    modifiers(&SecurityAddon)
)]
struct LayerApiDoc;

/// Struct used by [`utoipa`] to generate `OpenApi` documentation for all [`mod@plant_layer`] endpoints.
#[derive(OpenApi)]
#[openapi(
    paths(
        plant_layer::heatmap,
        plant_layer::find_relations
    ),
    components(
        schemas(
            RelationsDto,
            RelationDto,
            SpatialRelationType
        )
    ),
    modifiers(&SecurityAddon)
)]
struct PlantLayerApiDoc;

/// Struct used by [`utoipa`] to generate `OpenApi` documentation for all [`mod@base_layer_image`] endpoints.
#[derive(OpenApi)]
#[openapi(
    paths(
        base_layer_image::find,
        base_layer_image::create,
        base_layer_image::update,
        base_layer_image::delete
    ),
    components(
        schemas(
            BaseLayerImageDto,
            UpdateBaseLayerImageDto,
        )
    ),
    modifiers(&SecurityAddon)
)]
struct BaseLayerImagesApiDoc;

/// Struct used by [`utoipa`] to generate `OpenApi` documentation for all [`mod@plantings`] endpoints.
#[derive(OpenApi)]
#[openapi(
    paths(
        plantings::find,
        plantings::create,
        plantings::update,
        plantings::delete
    ),
    components(
        schemas(
            PlantingDto,
            TimelinePagePlantingsDto,
            UpdatePlantingDto,
            TransformPlantingDto,
            MovePlantingDto,
            UpdateAddDatePlantingDto,
            UpdateRemoveDatePlantingDto,
            UpdatePlantingNoteDto,
            ActionDtoWrapperNewPlantings,
            ActionDtoWrapperUpdatePlantings,
            ActionDtoWrapperDeletePlantings,
            ActionDtoWrapperDeleteDrawings,
        )
    ),
    modifiers(&SecurityAddon)
)]
struct PlantingsApiDoc;

/// Struct used by [`utoipa`] to generate `OpenApi` documentation for all area endpoints.
#[derive(OpenApi)]
#[openapi(
    paths(
        areas::find,
        areas::create,
        areas::update,
        areas::delete
    ),
    components(
        schemas(
            AreaKind,
            AreaDto,
            NewAreaDto,
            UpdateAreaDto,
            UpdateAddDateAreaDto,
            UpdateRemoveDateAreaDto,
            Shade
        )
    ),
    modifiers(&SecurityAddon)
)]
struct AreasApiDoc;

/// Struct used by [`utoipa`] to generate `OpenApi` documentation for all [`mod@users`] endpoints.
#[derive(OpenApi)]
#[openapi(
    paths(
        users::find
    ),
    components(
        schemas(
            keycloak_api::UserDto
        )
    ),
    modifiers(&SecurityAddon)
)]
struct UsersApiDoc;

/// Struct used by [`utoipa`] to generate `OpenApi` documentation for all [`mod@guided_tour`] endpoints.
#[derive(OpenApi)]
#[openapi(
    paths(
        guided_tour::pause,
        guided_tour::find_by_user,
        guided_tour::complete_step,
        guided_tour::complete_steps_bulk,
    ),
    components(
        schemas(
            GuidedTourDto,
            CompleteGuidedTourStepDto,
            CompleteGuidedTourStepsDto
        )
    ),
    modifiers(&SecurityAddon)
)]
struct GuidedTourApiDoc;

/// Struct used by [`utoipa`] to generate `OpenApi` documentation for all [`mod@timeline`] endpoints.
#[derive(OpenApi)]
#[openapi(
    paths(
        timeline::get_timeline,
    ),
    components(
        schemas(
            TimelineEntryDto,
            TimelineDto
        )
    ),
    modifiers(&SecurityAddon)
)]
struct TimelineApiDoc;

/// Struct used by [`utoipa`] to generate `OpenApi` documentation for all [`mod@drawings`] endpoints.
#[derive(OpenApi)]
#[openapi(
    paths(
        drawings::find,
        drawings::create,
        drawings::update,
        drawings::delete,
    ),
    components(
        schemas(
            DrawingDto,
            RectangleProperties,
            EllipseProperties,
            FreeLineProperties,
            PolygonProperties,
            LabelTextProperties,
            ImageProperties,
            UpdateAddDateDrawingDto,
            UpdateRemoveDateDrawingDto,
            UpdateNotesDrawingDto,
            ActionDtoWrapperNewDrawings,
            ActionDtoWrapperUpdateDrawings,
            ActionDtoWrapperDeleteDrawings,
        )
    ),
    modifiers(&SecurityAddon)
)]
struct DrawingsApiDoc;

/// struct used by [`utoipa`] to generate `openapi` documentation for all [`mod@map_collaborators`] endpoints.
#[derive(OpenApi)]
#[openapi(
    paths(
        map_collaborators::create,
        map_collaborators::find,
        map_collaborators::delete,
    ),
    components(
        schemas(
            NewMapCollaboratorDto,
            MapCollaboratorDto,
            DeleteMapCollaboratorDto,
        )
    ),
    modifiers(&SecurityAddon)
)]
struct MapCollaboratorsApiDoc;

/// Merges `OpenApi` and then serves it using `Swagger`.
pub fn config(cfg: &mut web::ServiceConfig) {
    let mut openapi = ConfigApiDoc::openapi();
    openapi.merge(SeedApiDoc::openapi());
    openapi.merge(PlantsApiDoc::openapi());
    openapi.merge(MapApiDoc::openapi());
    openapi.merge(LayerApiDoc::openapi());
    openapi.merge(PlantLayerApiDoc::openapi());
    openapi.merge(BaseLayerImagesApiDoc::openapi());
    openapi.merge(PlantingsApiDoc::openapi());
    openapi.merge(AreasApiDoc::openapi());
    openapi.merge(UsersApiDoc::openapi());
    openapi.merge(TimelineApiDoc::openapi());
    openapi.merge(DrawingsApiDoc::openapi());
    openapi.merge(GuidedTourApiDoc::openapi());
    openapi.merge(MapCollaboratorsApiDoc::openapi());

    cfg.service(SwaggerUi::new("/doc/api/swagger/ui/{_:.*}").url("/doc/api/openapi.json", openapi));
}

/// Used by [`utoipa`] for `OAuth2`.
struct SecurityAddon;

impl Modify for SecurityAddon {
    fn modify(&self, openapi: &mut utoipa::openapi::OpenApi) {
        // We can unwrap safely since there already is components registered.
        #[allow(clippy::unwrap_used)]
        let components = openapi.components.as_mut().unwrap();

        let config = &Config::get().openid_configuration;
        let oauth2 = OAuth2::new([Flow::AuthorizationCode(AuthorizationCode::new(
            config.authorization_endpoint.clone(),
            config.token_endpoint.clone(),
            Scopes::new(),
        ))]);
        components.add_security_scheme("oauth2", SecurityScheme::OAuth2(oauth2));
    }
}