Generate Stripe-Like API DocsReady 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 ExtensonThis extension allows you to generate and preview the API Documentations right in the Visual Studio Code. Theneo AccountIf you do not have already, please sign up here Get Authentication TokenGo 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 extensionAfter you download the extension, click on "extension settings", in "Theneo: API KEY" add the key you just generated from the platform Generate API DocumentationOpen a json or .yaml file on VS Code Extension
RequirementsVScode 1.5+ Extension SettingsThis extension contributes the following settings:
Known IssuesNone yet Release Notes0.0.1Initial release with document preview and publish functionality for existing documents. 0.0.5Documentation and readme updates 0.0.6Fixed project list display issues 0.0.7Updated to support v2 editor projects 0.0.8Updated to support creating Theneo project from the extension 0.0.9Updated to preview project from the extension 1.0.01.0.1Added 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. 1.0.2A 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.
1.0.31.0.4Added GraphQL support. 1.0.51.0.61.0.72.0.0New Features
UsageExport Project from Theneo
Import Project to Theneo
Merge Project to Theneo
Open Preview
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. |