AVAP API Designer

The AVAP API Designer extension for Visual Studio Code empowers developers to create, manage, and maintain OpenAPI specification configurations, enabling seamless deployment of APIs as AVAP API repositories.

AVAP API Designer allows you to design your OpenAPI specs with ease, ensuring they are fully compatible with AVAP’s publishing system. Manage multiple specs, versions, and environments from a single interface inside Visual Studio Code.

To get started, visit AVAP Alexandria for comprehensive guides, and join the community discussions at AVAP Communities.

Support for Developers

The AVAP API Designer extension supports both Visual Studio Code desktop and vscode.dev online environments, providing free access to documentation and community resources.

Installed Extensions

AVAP API Designer requires the base extension AVAP Dev Extensions for Visual Studio Code to function correctly. Please ensure it is installed.

Quick start

• Step 1. Install the AVAP API Designer extension.

• Step 2. Create or import your OpenAPI specs configurations within the extension.

• Step 3. Use the built-in tools to validate, version, and publish your API specs as AVAP API repositories.

Overview of extension features

• Intuitive editor for OpenAPI specifications with syntax highlighting and validation.

• Version control and management for multiple API specs.

• Environment-specific configurations to manage different deployment targets.

• Integration with AVAP publishing tools to deploy specs as API repositories.

• Support for YAML and JSON OpenAPI formats.

AVAP CLI integration

Fully compatible with AVAP CLI, enabling command-line management and automation of API specs deployment.

Feedback

• Join the AVAP Community and share your feedback at communities.avapframework.com

• Follow AVAP updates on Twitter.

License

AVAP API Designer extension for Microsoft Visual Studio Code

Copyright (c) 101OBEX, CORP

All rights reserved.

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.