Generate Stripe-Like API Docs
Ready to standardize your API documentation and reduce the back-and-forth between your teams? Theneo is the only API documentation tool designed for your entire team, from developers to non-technical team members.
VS Code Extenson
This extension allows you to generate and preview the API Documentations right in the Visual Studio Code.
If you do not have already, please sign up here
Get Authentication Token
Go to your dashboard https://app.theneo.io/projects, click on your profile , than user settings and Github secret, and copy your secret key
Use the secret key in the extension
After you download the extension, click on "extension settings", in "Theneo: API KEY" add the key you just generated from the platform
Generate API Documentation
Open a json or .yaml file on VS Code Extension
This extension contributes the following settings:
Initial release with document preview and publish functionality for existing documents.
Documentation and readme updates
Fixed project list display issues
Updated to support v2 editor projects
Updated to support creating Theneo project from the extension
Updated to preview project from the extension
Added jsdoc support. Now you can create a project from jsdoc comments. You can create js file and add jsdoc comments to the functions and classes, then you can create a project from the extension.
A really nice feature is added to the extension. Now you can create a preview project from the extension. You don't need worry about losing your changes, because you can create a preview project and test your changes any time. See the list of commands below:
PREVIEW PROJECT - A workspace or functionality that allows users to create, edit, and review their changes before finalizing and publishing them.It provides an opportunity to verify and adjust any modifications in a controlled environment, minimizing the risk of introducing errors into the live project.
Added GraphQL support.
Export Project from Theneo
Import Project to Theneo
Merge Project to Theneo
The Theneo VS Code extension streamlines the API documentation process by integrating it into your development environment. It saves time and enhances efficiency by eliminating the need to switch between tools for documentation tasks.
With just a few clicks, you can generate a live preview of your API documentation, making it easier to develop and review your API descriptions and endpoints without ever leaving VS Code.