mirror of
https://github.com/adidas/api-guidelines.git
synced 2025-10-25 15:19:19 +00:00
GITBOOK-2: No subject
This commit is contained in:
@@ -0,0 +1,2 @@
|
||||
# Tooling
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
# Command Line Interface (CLI)
|
||||
|
||||
Unfortunately, Swaggerhub is not offering a Command Line Interface (CLI) tool which allows including this capability as part of CICD workflows. 
|
||||
|
||||
For this, there is an official AsyncAPI CLI tool which can be checked here: https://www.asyncapi.com/tools/cli. This includes a validator against the AsyncAPI spec, templated generators, version conversion, spec optimizer, bundler, etc.
|
||||
|
||||
For example, to validate a yaml spec file:
|
||||
|
||||
```
|
||||
asyncapi validate --file your-asyncapi-file.yaml
|
||||
```
|
||||
@@ -0,0 +1,6 @@
|
||||
# Editors
|
||||
|
||||
Aside from Swaggerhub editing capabilities, other alternative editor options are available:
|
||||
|
||||
* AsyncAPI Studio: A web-based editor designed specifically for creating and validating AsyncAPI documents.
|
||||
* Visual Studio Code: VS Code can be extended with plugins like "AsyncAPI for VS Code" to provide AsyncAPI-specific features, for editing AsyncAPI files.
|
||||
@@ -0,0 +1,9 @@
|
||||
# Generators
|
||||
|
||||
These tools are capable of generate a variety of outputs from any valid AsyncAPI spec, including:
|
||||
|
||||
* API documentation in various formats like HTML, Markdown, or OpenAPI
|
||||
* Code samples in various programming languages like Python, Java, and Node.js based on your API definition. 
|
||||
* Functionally complete applications
|
||||
|
||||
There is an official generator tool which can be checked here: [https://www.asyncapi.com/docs/tools/](https://www.asyncapi.com/docs/tools/)generator.
|
||||
Reference in New Issue
Block a user