Local server offering a variety of APIs that can be used to test code generated by AutoRest (https://github.com/Azure/autorest)
Перейти к файлу
Mingzhe Huang 4fb0eb0511
build: bump version to 3.3.50 (#426)
2024-08-26 18:07:40 -04:00
.azure-pipelines
.scripts
.vscode
definitions
docs
legacy
routes
src
swagger
test
.editorconfig
.eslintrc.yml
.gitattributes
.gitignore
.npmignore
.prettierignore
.prettierrc.yml
CHANGELOG.md
LICENSE
README.md
SECURITY.md
jest.config.js
package-lock.json
package.json
swagger.json
tsconfig.build.json
tsconfig.json

README.md

Test server V2

Requirements

  • Node.js

Recommended:

  • VSCode, with the following plugins
    • Prettier
    • ESLint
    • EditorConfig

Usage

# Start testserver
autorest-testserver run

# Start testserver at given port
autorest-testserver run --port=<port>

# Start testserver without reseting the coverage. This can be used when you are running the test server multiple times to get the full coverage.
autorest-testserver run --appendCoverage

# Stop testserver
autorest-testserver stop

# Stop testserver running at the given port
autorest-testserver stop --port=<port>

# Sepecify the coverage directory
autorest-testserver run --coverageDirectory=<path>

Coverage upload

Upload the coverage produce by the autorest testserver.

autorest-testserver-coverage publish \
  --coverageDirectory=<path> \
  --repo=<repo> \
  --ref=<path> \
  --githubToken=<ghToken> \
  --azStorageAccount=<account> \
  --azStorageAccessKey=<azStorageKey>

Clear coverage folder

Clear the coverage folder. --coverageDirectory is optional. It defaults to ./coverage

autorest-testserver-coverage clear [--coverageDirectory=<path>]

Developping

# Install dependencies
npm install

# Start for dev: Will start the server and automatically restart in case there is changes in the files.
npm run start:dev

# Start for running: Will build and start the server
npm run start

# Format all the files(Required for CI). Use prettier vscode extension(or other editor prettier integration) for on save formatting.
npm run format

Writing mock apis

See docs