Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: AsyncAPI Server Bundle Parse API
version: '1.0'
description: 'The AsyncAPI Server API exposes the official AsyncAPI tooling
(validation, parsing, conversion, code generation, bundling, diffing)
over HTTP. It is open source under the AsyncAPI Initiative (now part of
the AsyncAPI CLI repository) and can be self-hosted via Docker.
Note: The AsyncAPI specification itself is a documentation/specification
standard, not an API. This document covers the companion AsyncAPI Server
API which provides the runtime HTTP surface.
'
contact:
name: AsyncAPI Initiative
url: https://www.asyncapi.com
license:
name: Apache-2.0
url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://api.asyncapi.com/v1
description: Public hosted AsyncAPI Server API operated by the AsyncAPI Initiative
- url: http://localhost
description: Self-hosted AsyncAPI Server API (Docker / npm)
tags:
- name: Parse
paths:
/parse:
post:
tags:
- Parse
summary: Parse an AsyncAPI document
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- asyncapi
properties:
asyncapi:
oneOf:
- type: object
- type: string
responses:
'200':
description: Parsed document
content:
application/json:
schema:
type: object
properties:
parsed:
type: string
'422':
$ref: '#/components/responses/Problem'
components:
schemas:
Problem:
type: object
properties:
type:
type: string
format: uri
title:
type: string
status:
type: integer
detail:
type: string
instance:
type: string
responses:
Problem:
description: RFC 7807 problem response
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'