anferov / wiki Goto Github PK

@startuml

left to right direction

title Схема проекта

component plantUmlRenderer #990000 {
    
}

component swaggerRenderer #990000 {
    
}


interface Linkable {
    +getLink(): link
}

abstract class publishable implements Linkable {
    
    +getName(): string
    +activeFrom(): Date
    +activeTo(): ?Date
}

class version extends publishable{
    -magor: int
    -minor: int
    -patch: int
    +__toString():string
}

class Link {
    -class: string
    -id: uuid
    -slug
}

class Image implements Linkable {

}

class article extends publishable{
    -markdownText
    +getVersion(): version
    +getVersions(): []version
    +getContents(): string
}

class tag extends publishable {
    +getColor()
}



class swaggerParser implements ParserInterface
{
    Класс преобразует разметку вида 
    ```swagger в html представление
}

class planumlParser implements ParserInterface{
    Данный класс рендерит на лету разметку вида
    ```plantuml используя сторонный сервис 
    --
    -defaultSyle: string
    -defaultScheme: string
}
note right
    Продразумевается что парсеры 
    дополнительно формируют:
    - описание из диаграммы или картики
    - alt подпись
    - прочие сео штучки
end note

interface ParserInterface {
    +parse(string): string
}

class "MarkdownParser" as parser #003399 implements ParserInterface
{
    
}

class "MarkdownProcessor" as processor
{
    Класс отвечает за делегирование обработки
    преобразования markdown в html в 
    подключенные в него сервисы
    ==
    -parsers[]
    -cache
    --
    +getContents(article):string
    +addParser(Parser)
}

class VideoParser implements ParserInterface{
    Данный парсер достает из текста ссылки
    на видео (ютуб и прочие) и формирует из них 
    плеер в html5 с превью 
}

class DeepLinkParser implements ParserInterface{
    Данный парсер достает из текста 
    строку по шаблону, нахоидит 
    такую запись в бд и в зависимости 
    от типа элемента отрисовывает его
    в html

    так будут отрисовываться картинки
    из таблицы изображений
}

Linkable<-*Link
article "1" -r- "0..*" tag
article "1" -l- "1..*" version

processor "1" <-u-* "1..*" ParserInterface
swaggerParser<.d.>plantUmlRenderer : Сервис рендерит\nкартинку plantuml
planumlParser<.d.>swaggerRenderer : Сервис рендерит\nswagger html

@enduml