@webex/api-samples

samples

This directory contains the parsed specs version, converted with the OAS3 converter and passed to the DevNet widgets. These widgets give developers the chance to try out the spec right in their browser.

Setup

To set up the project, follow these steps:

• Go to the root directory of the project where the package.json file is.
• Install the necessary dependencies.
  • Usage: yarn install from the root folder.

Available Scripts

Before you start, make sure to run the parse command on the existing specifications.

• Usage: yarn workspace @webex/api-publisher parse ../openapi ../samples/public/openapi.
• This command parses the specifications and creates OpenAPI files in the output directory you specify.
• Check that ../samples/public/openapi is in the directory.

Next, in the project directory, you can:

yarn start

This starts the samples app in development mode and serves the parsed spec in your browser. Open http://localhost:3000 to see it in your browser, or use whichever port is active.

Any edits you make will cause the page to reload.

yarn build

This builds the app for production in the build folder.