Api

gcp/Item/Api
include('gcp/Item/Api')
Illustration Api ApiCard ApiGroup
illustration for Illustration illustration for Api illustration for ApiCard illustration for ApiGroup

Sprites

The item provides the following sriptes:

  • <$ApiXs>
  • <$ApiSm>
  • <$ApiMd>
  • <$ApiLg>

Api

Load remotely

@startuml
' configures the library
!global $LIB_BASE_LOCATION="https://raw.githubusercontent.com/tmorin/plantuml-libs/master/distribution"

' loads the library's bootstrap
!include $LIB_BASE_LOCATION/bootstrap.puml

' loads the package bootstrap
include('gcp/bootstrap')

' loads the Item which embeds the element Api
include('gcp/Item/Api')

' renders the element
Api('Api', 'Api', 'an optional tech label', 'an optional description')
@enduml

Load locally

@startuml
' configures the library
!global $INCLUSION_MODE="local"
!global $LIB_BASE_LOCATION="../.."

' loads the library's bootstrap
!include $LIB_BASE_LOCATION/bootstrap.puml

' loads the package bootstrap
include('gcp/bootstrap')

' loads the Item which embeds the element Api
include('gcp/Item/Api')

' renders the element
Api('Api', 'Api', 'an optional tech label', 'an optional description')
@enduml

ApiCard

Load remotely

@startuml
' configures the library
!global $LIB_BASE_LOCATION="https://raw.githubusercontent.com/tmorin/plantuml-libs/master/distribution"

' loads the library's bootstrap
!include $LIB_BASE_LOCATION/bootstrap.puml

' loads the package bootstrap
include('gcp/bootstrap')

' loads the Item which embeds the element ApiCard
include('gcp/Item/Api')

' renders the element
ApiCard('ApiCard', 'Api Card', 'an optional description')
@enduml

Load locally

@startuml
' configures the library
!global $INCLUSION_MODE="local"
!global $LIB_BASE_LOCATION="../.."

' loads the library's bootstrap
!include $LIB_BASE_LOCATION/bootstrap.puml

' loads the package bootstrap
include('gcp/bootstrap')

' loads the Item which embeds the element ApiCard
include('gcp/Item/Api')

' renders the element
ApiCard('ApiCard', 'Api Card', 'an optional description')
@enduml

ApiGroup

Load remotely

@startuml
' configures the library
!global $LIB_BASE_LOCATION="https://raw.githubusercontent.com/tmorin/plantuml-libs/master/distribution"

' loads the library's bootstrap
!include $LIB_BASE_LOCATION/bootstrap.puml

' loads the package bootstrap
include('gcp/bootstrap')

' loads the Item which embeds the element ApiGroup
include('gcp/Item/Api')

' renders the element
ApiGroup('ApiGroup', 'Api Group', 'an optional tech label') {
    note as note
        the content of the group
    end note
}
@enduml

Load locally

@startuml
' configures the library
!global $INCLUSION_MODE="local"
!global $LIB_BASE_LOCATION="../.."

' loads the library's bootstrap
!include $LIB_BASE_LOCATION/bootstrap.puml

' loads the package bootstrap
include('gcp/bootstrap')

' loads the Item which embeds the element ApiGroup
include('gcp/Item/Api')

' renders the element
ApiGroup('ApiGroup', 'Api Group', 'an optional tech label') {
    note as note
        the content of the group
    end note
}
@enduml