Please enable JavaScript.

Coggle requires JavaScript to display documents.

Gravitee, Applications - Coggle Diagram

- - - - Create V2 API
        
        1- General
        
        Name
        
        Version
        
        Description
        
        Context-path
        
        2- Gateway
        
        Backend
        Advanced Mode
        
        Tenants
        Sharding Tags
        
        3- Plan
        
        Name
        
        Security Type (API key, Keyless)
        
        Auto Validate Subscription (True/False)
        
        Description
        Characteristics
        Rate Limit
        
        Max Requests
        
        Period time
        
        Period Time Unit
        Quota
        
        Max Requests
        
        Period Time
        
        Period Time Unit
        Resource Filtering +
        
        Ant Pattern
        
        Methods {Get, Post, Put, Delete}
        
        4- Doc
        
        Import File
        
        5- Deployment
        
        2 more items...
      - Import V2 API
        
        Upload a File
        yml, yaml, json, wsdl, xml
        v2, v4
        
        Swagger / Open API
        
        Swagger Descriptor URL
        
        Create documentation +/-
        
        Create the path mapping for analytics +/-
        
        Create flows on paths +/-
        { +/-
        
        Apply JSON Validation Policy
        
        Apply Mock Policy
        
        Apply REST to SOAP Transformer Policy
        
        Apply Validate Request Policy
        
        Apply XML Validation Policy
        }
        
        import
        
        API Definition URL
        
        Import
        
        WSDL
        
        WSDLDescriptor URL
        
        Create documentation +/-
        
        Create the path mapping for analytics +/-
        
        Create flows on paths +/-
        { +/-
        
        Apply JSON Validation Policy
        
        Apply Mock Policy
        
        Apply REST to SOAP Transformer Policy
        
        Apply Validate Request Policy
        
        Apply XML Validation Policy
        }
        
        import
      - Design API
    - - Create V4 API
        
        API Details
        
        API name
        
        Version Number
        Description
        
        Entrypoints
        Select how you want your backend service exposed
        Choose the consumption style of your API based on your upstream backend service architecture
        
        Proxy Generic Protocol
        Choose this mode if you want to proxy an upstream HTTP or TCP service such as a REST API, SOAP service, WebSocket server or gRPC service.
        Can proxy REST API, SOAP API
        WebSocket Server
        gRPC Service
        Via HTTP or TCP
        
        Http Proxy
        
        Context-path
        
        1 more item...
        
        TCP Proxy
        
        Add Host
        
        1 more item...
        
        Protocol Mediation
        This mode serves incoming requests on a generic protocol such as HTTP and translates the request into a specialized backend protocol such as Kafka or Solace.
        Can expose
        Kafka
        MQTT
        RabbitMQ
        Solace
        
        HTTP GET
        Send an HTTP GET request including the data directly in the request URL and process the response from the HTTP server.
        
        Context-path
        
        1 more item...
        
        HTTP GET
        Limit messages count
        500
        Maximum number of messages to retrieve.
        Limit messages duration
        Maximum duration in milliseconds to wait to retrieve the expected number of messages (See Limit messages count). The effective number of retrieved messages could be less than expected it maximum duration is reached.
        Limit messages duration (in ms)
        5000
        Allow sending messages headers to client in payload
        Each header will be sent as extra field in payload. For JSON and XML, in a dedicated headers object. For plain text, following 'key=value' format. Default is false.
        Allow sending messages headers to client in payload
        Default is false. (T/F)
        Allow sending messages metadata to client in payload
        Allow sending messages metadata to client in payload. Each metadata will be sent as extra field in the payload. For JSON and XML, in a dedicated metadata object. For plain text, following 'key=value' format. Default is false.
        Allow sending messages metadata to client in payload
        Default is false.
        Response Status Code
        200
        Enter an HTTP status code between 200 and 299 to override the default success response status (200).
        Quality of service
        Define the guaranteed level of message delivery.
        A given quality of service may or may not be supported by a given endpoint. Support also depends on the protocol used for the entrypoint. Please check the documentation for QoS compatibility. Learn more
        Quality of Service
        AUTO/AT-MOST-ONCE/AT-LEAST-ONCE
        
        HTTP POST
        Send an HTTP POST request including URL parameters in the request and process the response from the HTTP server.
        
        HTTP POST
        +/-Allow add request Headers to the generated message
        Each headers from incoming request will be added to the generated message headers.
        +/-Produce Empty Message Flow When Called
        Will initiate an empty message flow and gives policies full access to the context (and thus the ability to construct messages with metadata, headers, etc) whenever the POST request is made to the entrypoint.
        Response Status Code
        202
        Enter an HTTP status code between 200 and 299 to override the default success response status (202).
        Quality of service
        Define the guaranteed level of message delivery.
        A given quality of service may or may not be supported by a given endpoint. Support also depends on the protocol used for the entrypoint. Please check the documentation for QoS compatibility. Learn more
        Quality of Service
        AUTO
        
        Server-Sent Events
        Designed to use the JavaScript EventSource API in order to subscribe to a stream of data in the browser.
        
        Server-Sent Events
        Define the interval in which heartbeat are sent to client
        5000
        Interval must be higher or equal than 2000ms. Each heartbeat will be sent as extra empty comment ":"
        +/-Allow sending messages metadata to client as SSE comments
        Each metadata attribute will be sent as extra line following ":key=value" format.
        +/-Allow sending messages headers to client as SSE comments
        Each header will be sent as extra line following ":key=value" format.
        Quality of service
        Define the guaranteed level of message delivery.
        A given quality of service may or may not be supported by a given endpoint. Support also depends on the protocol used for the entrypoint. Please check the documentation for QoS compatibility. Learn more
        Quality of Service
        AUTO
        
        Webhook
        A webhook is a lightweight API that powers one-way data sharing triggered by events.
        
        Configure your API entrypoints
        Configure how your users will consume your API
        Webhook
        Server errors and DLQ
        If this option is disabled and DLQ is enabled then messages unsuccessfully pushed due to 5xx are stored in the defined external storage.
        Interrupt messages consumption in case of 5xx error
        If the request to the callback URL ends with a 5xx error, this option determines if the subscription should be stopped or not. Default is true.
        Exceptions and DLQ
        If this option is disabled and DLQ is enabled then messages unsuccessfully pushed due to exceptions are stored in the defined external storage.
        Interrupt messages consumption in case of any exception
        If the request to the callback URL ends with an exception such as HostUnknownException, TimeoutException, this option determines if the subscription should be stopped or not. Default is true.
        HTTP Options
        Connect timeout (ms)
        3000
        Maximum time to connect to the webhook in milliseconds.
        Read timeout (ms)
        10000
        Maximum time given to the webhook to complete the request (including response) in milliseconds.
        Idle timeout
        Maximum time a connection will stay in the pool without being used in milliseconds. Once the timeout has elapsed, the unused connection will be closed, allowing to free the associated resources.
        Idle timeout (ms)
        60000
        Max Concurrent Connections
        5
        Maximum pool size for connections. (default: 5, maximum: 20). Automatically set to 1 with qos AT_LEAST_ONCE or AT_MOST_ONCE.
        Proxy Options
        Select option
        No proxy/ SYSTEM LEVEL / FOR CLIENT CONNECTIONS
        Quality of service
        Define the guaranteed level of message delivery.
        A given quality of service may or may not be supported by a given endpoint. Support also depends on the protocol used for the entrypoint. Please check the documentation for QoS compatibility. Learn more
        Quality of Service
        AUTO
        
        Websocket
        Send messages to a server and receive event-driven responses without having to poll the server for a reply.
        
        Websocket
        Publisher configuration
        Enable the publication capability
        Allow to enable or disable the publication capability. By disabling it, you assume that the application will never be able to publish any message.
        Subscriber configuration
        Enable the subscription capability
        Allow to enable or disable the subscription capability. By disabling it, you assume that the application will never receive any message.
        Quality of service
        Define the guaranteed level of message delivery.
        A given quality of service may or may not be supported by a given endpoint. Support also depends on the protocol used for the entrypoint. Please check the documentation for QoS compatibility. Learn more
        Quality of Service
        AUTO
        
        Kafka Protocol
      - Import V4 API
    - - Pop-up Message