Welcome to the API Elements extension for Visual Studio Code! This is a totally untested extension which will improve your experience working with API description formats like API Blueprint and Swagger. It provides some great features, such as:
What's API Elements about?
API Elements is the structure for parse results of both API Blueprint and Swagger, and it is built on the Refract format. It provides a single format for interacting with parse results from various API description formats. So far, only API Blueprint and Swagger are supported.
Future development / ideas
Found a Bug or - do you need a particular feature?
Please file an issue at https://github.com/XVincentX/vscode-apielements.
This extension is built on top of Visual Studio template; so:
To run and develop do the following:
Note: If you're on a Unix envirnonment, you might want to use
Testing the sources
Sometimes the master branch is not in sync with the latest published version (which is normal). If you want to test the latest change in your VSCode instance, just follow the following steps
Symbol navigation is strongly dependant on sourcemaps quality provided by the parser. Currently, the following resources are indexed:
The idea would be, of course, to improve symbol navigation as much as possible and exploit sourcemaps in all their power. This, however, might take time. If you feel there are some important symbols I'm missing, please file an issue, I'll be happy to evaluate it.
Basic Apiary Integration
This extension is able to provide basic Apiary integration. Fundamentally, the entire Apiary client has been reimplemented following the Apiary API documentation. It means that you can perform the following actions:
without having to leave the editor at all.
Most of the process is actually automated. Thous, it will ask you to provide a
token and redirect you to the right page if it's not avaliable on your computer.
All those commands are listed with an
Even if I currently work for Apiary, this extension is my personal work and it's not backed by Apiary. If you're enjoying the extension and would like to help, consider a donation