AVAP API Specs

The AVAP API Specs extension for Visual Studio Code provides a standalone solution for visualizing and interacting with API specifications. With AVAP API Specs, users can explore available services of a project without requiring AVAP Developer credentials, enabling flexible and independent use.

To get started, visit AVAP Alexandria for resources and guides, or explore the AVAP Developer Portal for additional documentation.

Key Features

• Independent Functionality: Operates independently without requiring the AVAP Dev Extensions or AVAP Developer credentials.
• Configurable API Access:
  • Specify a Swagger URL to access API specifications for your desired project.
  • Optionally, include a consumer token for enhanced functionality such as API testing.
  • Mark the extension to override AVAP Developer credentials and prioritize the provided configuration.
• Interactive API Visualization:
  • View endpoints, parameters, and schemas in an intuitive interface.
  • Navigate through paths and operations using a clear, structured layout.
• Built-in Test Functionality: Test API calls directly from the extension interface with support for parameter inputs and dynamic token integration.

Support for Developers

AVAP API Specs is fully functional on vscode.dev, providing seamless access to API specifications and test capabilities. For additional resources, visit:

• AVAP Alexandria
• AVAP Communities

Installed Extensions

AVAP API Specs does not depend on or install any other extension. It is a standalone tool designed to operate independently.

Quick start

1. Install the AVAP API Specs extension from the Visual Studio Code marketplace.
2. Open the configuration panel to:
   • Specify a Swagger URL for your desired API project.
   • Optionally, add a consumer token for test functionality.
   • Mark the extension to prioritize the configuration over AVAP Developer credentials, if available.
3. Explore the API specs: Navigate through paths, parameters, and schemas in a user-friendly interface.
4. Test the APIs: Use the built-in functionality to input parameters and send real API requests.

Overview of the extension features

• Configuration Options: Flexibly connect to any project by specifying a Swagger URL and, optionally, a consumer token.
• API Path Visualization: Explore detailed API documentation, including parameters, responses, and descriptions.
• Testing Capabilities:
  • Input query parameters and tokens directly from the interface.
  • Execute real API calls and view the responses.
• Schema and Model Visualization: Review data structures in a clear and interactive manner.

AVAP CLI integration

While AVAP API Specs operates independently, you can enhance its functionality by using the AVAP CLI for advanced management commands. For more information, visit Get started with AVAP CLI.

Feedback

We value your feedback! Share your thoughts and suggestions with us at:

• AVAP Communities
• Follow us on Twitter for updates and announcements.

License

AVAP API Specs 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.