d360 v1.1.3

The d360 package provides the capability to both manage and synchronize your API Definition with Document360. By utilizing this package within Document360, you will be able to effortlessly generate API documentation for both internal and external consumers, automatically generated from your API definition files

Table of Contents

• Setup
• Commands
  • apidocs
  • apidocs:resync
• What's Next

Setup

In order to install our package, it is required that you have Node.js already installed on your system. Once Node.js is successfully installed, you can proceed to directly install our package from the npm registry.

npm install -g d360

Commands

Our npm package includes a list of available commands, which are as follows:

• apidocs - Generate API Documentation from your API Definition file
• apidocs:resync - Resync your API Definition

apidocs

By utilizing the 'apidocs' command, you will have the ability to generate API documentation directly from your API Definition file.

d360 apidocs --apiKey=c92e71ab-ebdf-4007-89ed-5d47493052cd
             --userId=3340e95e-2b68-4a3f-a8c9-124bcaec9972
             --versionId=d486783f-b833-446e-aa71-615ac51392c3
             --path=https://petstore.swagger.io/v2/swagger.json

apidocs:resync

With the 'apidocs:resync' command, you are able to update or resynchronize your API Definition.

d360 apidocs:resync --apiKey=c92e71ab-ebdf-4007-89ed-5d47493052cd
                    --userId=3340e95e-2b68-4a3f-a8c9-124bcaec9972
                    --apiReferenceId=d486783f-b833-446e-aa71-615ac51392c3
                    --path=https://petstore.swagger.io/v2/swagger.json

What's next

As part of our ongoing efforts to enhance the user experience of our d360 npm package, we are committed to supporting backward compatibility to the best of our ability.