api-simulator
Not just a mock server. Turn an OpenAPI spec into TypeScript-based simulation, with state management, hot reload, and a REPL.
File Explorer
Download Latest Version (.zip)- calm-headers-match.md
- complete-runner-shutdown.md
- config.json
- contained-generation.md
- linear-prefix-normalization.md
- local-path-schemes.md
- prefix-boundaries.md
- quiet-random-responses.md
- random-header-casing.md
- README.md
- reject-unsafe-routes.md
- request-header-types.md
- response-header-casing.md
- rollback-startup-resources.md
- safe-path-values.md
- shared-path-parameters.md
- base.Dockerfile
- devcontainer.json
- Dockerfile
- issue-proposals.instructions.md
- .gitkeep
- audit-security-detect-unsafe-regex-warnings.md
- config-add-version-field-to-spec-config.md
- disable-import-no-named-as-default-member-for-js-yaml-interop.md
- docs-add-repl-gif-to-getting-started.md
- docs-multiple-version-support.md
- docs-pattern-persistent-state.md
- docs-pattern-record-and-replay.md
- docs-pattern-webhook-simulation.md
- generator-emit-versions-ts.md
- generator-operation-type-coder-version-map.md
- generator-version-subdirectories-for-remaining-coders.md
- openapi-32-additional-operations.md
- openapi-32-components-mediatypes.md
- openapi-32-datavalue-serializedvalue-examples.md
- openapi-32-deprecated-security-scheme.md
- openapi-32-discriminator-default-mapping.md
- openapi-32-json-schema-alignment.md
- openapi-32-oauth2-device-authorization.md
- openapi-32-optional-discriminator-propertyname.md
- openapi-32-optional-response-description.md
- openapi-32-query-http-method.md
- openapi-32-querystring-parameter.md
- openapi-32-self-document-identity.md
- openapi-32-server-name-field.md
- openapi-32-streaming-sse-itemschema.md
- openapi-32-xml-nodetype.md
- re-enable-or-remove-disabled-tests-for-jest-no-disabled-tests.md
- reduce-security-detect-non-literal-fs-filename-warnings.md
- reduce-security-detect-object-injection-warnings.md
- refactor-conditional-tests-for-jest-no-conditional-in-test.md
- repl-multi-api-context-and-routes.md
- repl-scenario-command-with-group-qualifier.md
- repl-tab-completion-for-multi-api-scenario.md
- repl-version-aware-context-routes-scenario.md
- resolve-jest-expect-expect-warnings.md
- scenarios-version-aware-loading.md
- server-route-group-version-url-prefixes.md
- update-capture-groups-for-regexp-prefer-named-capture-group.md
- create_issues.py
- number_adrs.py
- SKILL.md
- SKILL.md
- SKILL.md
- SKILL.md
- SKILL.md
- check-site-links.yaml
- ci.yaml
- codeql.yml
- coveralls.yaml
- create-issues.yml
- debug-windows.yaml
- deploy-site.yaml
- first-10-minutes.yml
- manual-acceptance-tests.yaml
- mutation-testing.yaml
- number-adrs.yaml
- release.yaml
- renovate-changesets.yaml
- renovate-copilot-fix.yaml
- FUNDING.yml
- pull_request_template.md
- post-commit
- settings.json
- head-custom-google-analytics.html
- 000-architecture-decision-records.md
- 001-apply-command-with-function-injection.md
- README.md
- xxx-first-class-store.md
- xxx-multiple-api-support.md
- xxx-onboarding-first-run-experience.md
- xxx-package-oriented-monorepo.md
- 001-openapi-trailing-slash-dotfiles.md
- 002-multi-spec-shared-prefix-fallthrough.md
- 003-multi-spec-startup-only-primary.md
- 004-prune-obsolete-path-type-dotfiles.md
- 005-derived-group-prefix-duplicates-paths.md
- ai-assisted-monorepo-migration.md
- design-principles.md
- lint-warning-recommendations.md
- public-package-contract.md
- release-bootstrap.md
- index.html
- index.html
- persona-github-evaluation.md
- persona-website-evaluation.md
- personas.md
- {petId}.ts
- _.context.ts
- pets.ts
- pets.ts
- counterfact.test.mjs
- openapi.yaml
- package-lock.json
- package.json
- README.md
- tsconfig.counterfact.json
- reusable-request.mjs
- index.ts
- raw-http-client.ts
- route-builder.ts
- route-catalog.ts
- client-consumer-smoke.mjs
- raw-http-client.test.ts
- route-builder.test.ts
- route-catalog.test.ts
- License.md
- package.json
- README.md
- tsconfig.json
- counterfact.js
- README.md
- register-ts-loader.mjs
- taglines.txt
- ts-loader.mjs
- generated-code.md
- hot-reload.md
- middleware.md
- multiple-versions.md
- programmatic-api.md
- proxy.md
- repl.md
- route-builder.md
- routes.md
- state.md
- typescript-native-mode.md
- without-openapi.md
- agentic-sandbox.md
- ai-assisted-implementation.md
- automated-integration-tests.md
- custom-middleware.md
- executable-spec.md
- explore-new-api.md
- federated-context.md
- hybrid-proxy.md
- index.md
- mock-with-dummy-data.md
- model-the-workflow.md
- multiple-versions.md
- reference-implementation.md
- repl-inspection.md
- scenario-scripts.md
- shared-store.md
- simulate-failures.md
- simulate-latency.md
- test-context-not-handlers.md
- comparison.md
- faq.md
- first-10-minutes.md
- getting-started.md
- reference.md
- usage.md
- banner.ts
- check-for-updates.ts
- README.md
- run.ts
- telemetry.ts
- paths-to-routes.ts
- README.md
- update-route-types.ts
- ensure-directory-exists.ts
- forward-slash-path.ts
- load-config-file.ts
- README.md
- api-runner.ts
- app.ts
- config.ts
- README.md
- banner.test.ts
- check-for-updates.test.ts
- run.test.ts
- telemetry.test.ts
- multiple-apis.yaml
- add-extensions.yaml
- remove-deprecated.yaml
- update-info.yaml
- example.yaml
- paths-to-routes.test.ts
- update-route-types.test.ts
- compatibility-manifest.json
- generated-files.json
- openapi.yaml
- pack-files.json
- counterfact-consumer-smoke.mjs
- forward-slash-path.test.ts
- load-config-file.test.ts
- api-runner.test.ts
- app-types.test.ts
- app.test.ts
- CHANGELOG.md
- License.md
- llms.txt
- package.json
- petstore.yaml
- README.md
- tsconfig.json
- generate-routes.mjs
- code-generator.ts
- coder.ts
- context-file-token.ts
- ensure-directory-exists.ts
- forward-slash-path.ts
- index.ts
- jsdoc.ts
- openapi-path.ts
- operation-coder.ts
- operation-type-coder.ts
- operation-type-name-mapping.ts
- parameter-export-type-coder.ts
- parameters-type-coder.ts
- printers.ts
- prune.ts
- read-only-comments.ts
- README.md
- repository.ts
- requirement.ts
- reserved-words.ts
- response-type-coder.ts
- responses-type-coder.ts
- scenario-file-generator.ts
- schema-coder.ts
- schema-type-coder.ts
- script.ts
- specification.ts
- type-coder.ts
- versions-ts-generator.ts
- wait-for-event.ts
- watch-options.ts
- windows-escape.ts
- generate.test.ts.snap
- operation-coder.test.ts.snap
- operation-type-coder.test.ts.snap
- parameters-type-coder.test.ts.snap
- generator-consumer-smoke.mjs
- code-generator.test.ts
- coder.test.ts
- generate.test.ts
- integration.test.ts
- jsdoc.test.ts
- operation-coder.test.ts
- operation-type-coder.test.ts
- parameters-type-coder.test.ts
- petstore.yaml
- prune.test.ts
- repository.test.ts
- requirement.test.ts
- response-type-coder.test.ts
- responses-type-coder.test.ts
- schema-coder.test.ts
- schema-type-coder.test.ts
- script.test.ts
- specification.test.ts
- versions-ts-generator.test.ts
- CHANGELOG.md
- License.md
- package.json
- README.md
- tsconfig.json
- load-local-spec.mjs
- apply-overlay.ts
- index.ts
- load-openapi-document.ts
- read-file.ts
- apply-overlay.test.ts
- load-openapi-document.test.ts
- read-file.test.ts
- CHANGELOG.md
- License.md
- package.json
- README.md
- tsconfig.json
- complete-routes.mjs
- index.ts
- repl.ts
- repl-consumer-smoke.mjs
- repl.test.ts
- CHANGELOG.md
- License.md
- package.json
- README.md
- tsconfig.json
- registries.mjs
- admin-api-middleware.ts
- create-koa-app.ts
- koa-bodyparser.d.ts
- openapi-middleware.ts
- routes-middleware.ts
- constants.ts
- context-registry.ts
- convert-js-extensions-to-cjs.ts
- determine-module-kind.ts
- dispatcher.ts
- file-discovery.ts
- is-proxy-enabled-for-path.ts
- json-to-xml.ts
- load-openapi-document.ts
- middleware-detector.ts
- module-dependency-graph.ts
- module-loader.ts
- module-tree.ts
- openapi-document.ts
- openapi-watcher.ts
- precinct.d.ts
- README.md
- registry.ts
- request-validator.ts
- response-builder.ts
- response-validator.ts
- scenario-registry.ts
- store-loader.ts
- tools.ts
- transpiler.ts
- uncached-import.ts
- uncached-require.cjs
- ensure-directory-exists.ts
- forward-slash-path.ts
- wait-for-event.ts
- windows-escape.ts
- index.ts
- koa.ts
- msw.ts
- runtime-can-execute-erasable-ts.ts
- runtime-config.ts
- openapi.yaml
- admin-api-middleware.test.ts
- koa-middleware.test.ts
- multi-routes-middleware.test.ts
- openapi-middleware.test.ts
- context-registry.test.ts
- convert-js-extension-to-cjs.test.ts
- create-koa-app.test.ts
- deterimine-module-kind.test.ts
- dispatcher.proxy.test.ts
- dispatcher.test.ts
- file-discovery.test.ts
- is-proxy-enabled-for-path.test.ts
- json-to-xml.test.ts
- middleware-detector.test.ts
- module-dependency-graph.test.ts
- module-loader.test.ts
- module-tree.test.ts
- openapi-document.test.ts
- registry.test.ts
- response-builder.test.ts
- response-validator.test.ts
- scenario-registry.test.ts
- store-loader.test.ts
- tools.test.ts
- transpiler.test.ts
- windows-escape.test.ts
- msw.test.ts
- runtime-can-execute-erasable-ts.test.ts
- CHANGELOG.md
- License.md
- package.json
- README.md
- tsconfig.json
- middleware.ts
- cookie-options.ts
- counterfact-response.ts
- example-names.ts
- example.ts
- generic-response-builder.ts
- http-status-code.ts
- if-has-key.ts
- index.ts
- maybe-promise.ts
- media-type.ts
- middleware.ts
- omit-all.ts
- omit-value-when-never.ts
- open-api-content.ts
- open-api-header.ts
- open-api-operation.ts
- open-api-parameters.ts
- open-api-response.ts
- random-function.ts
- response-builder-factory.ts
- response-builder.ts
- streaming-content-types.ts
- wide-operation-argument.ts
- wide-response-builder.ts
- types.test-d.ts
- License.md
- package.json
- README.md
- tsconfig.json
- check-package-boundaries.mjs
- check-package-boundaries.test.mjs
- check-publishable.mjs
- release-preflight.mjs
- run-mutation-tests.mjs
- test-package-closures.mjs
- CNAME
- counterfact.svg
- llms.txt
- robots.txt
- DocLayout.astro
- MainLayout.astro
- [...slug].astro
- index.astro
- main.js
- main.css
- content.config.ts
- env.d.ts
- .gitignore
- astro.config.mjs
- package-lock.json
- package.json
- tsconfig.json
- SKILL.md
- SKILL.md
- SKILL.md
- examples.md
- SKILL.md
- SKILL.md
- SKILL.md
- configured_portfolio.feature
- contract_evolution.feature
- developer_journey.feature
- generated_openapi.feature
- legacy_swagger.feature
- __init__.py
- journey.py
- conftest.py
- requirements.txt
- test_configured_portfolio_journey.py
- test_contract_evolution_journey.py
- test_developer_journey.py
- test_generated_openapi_journey.py
- test_legacy_swagger_journey.py
- .gitignore
- .mise.toml
- .putout.json
- .swcrc
- .yarnrc.yml
- _config.yaml
- AGENTS.md
- CLAUDE.md
- CNAME
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- counterfact.svg
- eslint.config.js
- jest.config.js
- jest.mutation.config.js
- License.md
- package.json
- README.md
- renovate.json
- SECURITY.md
- stryker.config.mjs
- tsconfig.base.json
- tsconfig.eslint.json
- tsconfig.json
- tsconfig.tsd.json
- typescript-badge.png
- yarn.lock
# Installation Guide
1. Get the code
git clone https://github.com/counterfact/api-simulator
Downloads the entire project code from GitHub to your computer.
cd api-simulator
Moves into the project folder you just downloaded.
2. Node.js
Easy RecommendedPrerequisites
npm install
Downloads and installs the libraries listed in package.json.
npm start
Starts the development/run server.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
3. Python
EasyPrerequisites
pip install -r test-black-box/requirements.txt
Installs the Python libraries listed in requirements.txt (or similar).
python <์คํํ ํ์ผ๋ช
>.py # README์์ ์ ํํ ์คํ ํ์ผ๋ช
์ ํ์ธํ์ธ์
Runs the Python script (or module).
If it runs without errors and prints output in the terminal, it worked.
// repository documentation
Was this content helpful?
(0 ratings)