Codiga Code Snippet: AsyncAPI Spec 2.3.0

asyncapi: '2.3.0'
id: 'urncomloremipsumlorem'
title:  'AsyncAPI Sample App'
description: 'This is a sample server.'
termsOfService: 'https//asyncapi.org/terms/'
contact:
  name: 'API Support'
  url: https//www.asyncapi.org/support
  email: support@asyncapi.org
license:
  name: 'Apache 2.0'
  url: 'https//www.apache.org/licenses/LICENSE-2.0.html'
version: '1.0.1'
servers:
  development:
    url: 'development.gigantic-server.com'
    description: 'Development server'
    protocol: 'amqp'
    protocolVersion: '0.9.1'
  staging:
    url: 'staging.gigantic-server.com'
    description: 'Staging server'
    protocol: 'amqp'
    protocolVersion: '0.9.1'
  production:
    url: 'api.gigantic-server.com'
    description: 'Production server'
    protocol: 'amqp'
    protocolVersion: '0.9.1'
  defaultContentType: 'application/json'
'user/signedup':
  subscribe:
    message:
      $ref: "#/components/messages/userSignedUp"
components:
  schemas:
    Category:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
    Tag:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
  servers:
    development:
      url: development.gigantic-server.com
      description: Development server
      protocol: amqp
      protocolVersion: 0.9.1
  channels:
    user/signedup:
      subscribe:
        message:
          $ref: "#/components/messages/userSignUp"
  messages:
    userSignUp:
      summary: Action to sign a user up.
      description: |
        Multiline description of what this action does.
        Here you have another line.
      tags:
        - name: user
        - name: signup
      headers:
        type: object
        properties:
          applicationInstanceId:
            description: Unique identifier for a given instance of the publishing application
            type: string
      payload:
        type: object
        properties:
          user:
            $ref: "#/components/schemas/userCreate"
          signup:
            $ref: "#/components/schemas/signup"
  parameters:
    userId:
      description: Id of the user.
      schema:
        type: string
  correlationIds:
    default:
      description: Default Correlation ID
      location: $message.header#/correlationId
  messageTraits:
    commonHeaders:
      headers:
        type: object
        properties:
          my-app-header:
            type: integer
            minimum: 0
            maximum: 100

AsyncAPI Spec 2.3.0

imabp

AsyncAPI Open Source

  <body>
 <h1>User Signed Up</h1>
 <div class="message">Thank you for signing up!</div>
 </body>

The following lines define the configuration for the sample app.

id: 'urncomloremipsumlorem' title: 'AsyncAPI Sample App' description: 'This is a sample server. It uses the AsyncAPI library for performing asynchronous tasks.'

termsOfService: 'https//asyncapi.org/terms/' contact:

name: 'API Support' url: https://www.asyncapi.org/support email: support@asyncapi.org license:

name: 'Apache 2.0' url: 'https://www.apache.org/licenses/LICENSE-2.0.html' version: '1.0.1' servers:

development:

url: 'development.gigantic-server.com' description: 'Development server' protocol: 'amqp'

Shortcut: asyncapi.spec.2.3.0

0 Comments

Add Comment