OpenAPI to TypeScript generator and mock server
This project is maintained by pmcelhaney
Yes, you're meant to edit the imperative code under the paths directory in order to customize your mock server's behavior. Don't touch the types under path-types and components. If you do, Counterfact will overwrite your changes anyway.
Short answer: yes, commit everything.
Use your Git client to add and commit the directory containing Counterfact's output. It's best not get bogged down in the details. But if you really want to know, here are the details.
You absolutely should put the files under the paths directory under version control. That's your code. Counterfact generates starter files and after that doesn't touch the code again.
In theory, code under path-types and components can be reproduced exactly given the same input (OpenAPI file), so it might make sense to put those directories in your .gitignore. However, that depends on whether the OpenAPI file is in the same repository. That's not always the case, especially if the API is owned by a different team -- or a different organization.
Note that Counterfact creates .gitignore file that excludes the .cache directory. Do commit .gitignore, don't commit .cache.
never types?If you peek into the type definitions under path-types you may notice a bunch of references to never. For example, you might see query: never.
The upshot is you won't see query offered as an autocomplete when you type $. when you're writing code for that operation. And if you have code like $.query.id, TypeScript will yell at you.
This is by design. The code is generated from an OpenAPI description. If the OpenAPI description doesn't specify any query parameters, Counterfact assumes there's no reason to look for query parameters in the URL. If the OpenAPI description is incomplete, it's better to fix it at the source.
If your OpenAPI file is local, Counterfact will watch the file and automatically regenerate types whenever it changes. No restart required.
If you point to a URL like https://petstore3.swagger.io/api/v3/openapi.yaml, Counterfact only looks up the URL once at startup. So you would need to restart to pick up any changes.
If you have control over the OpenAPI (i.e. you're not getting it from a third party), we recommend working with a local file for a great developer experience.
No. The fact that you can change the code while the server is running is what makes mocking in Counterfact so pleasant. It watches for file changes and updates automatically. And the state of your context objects is preserved. You can even change the definition of a context object (_.context.js) and Counterfact will preserve the values of any properties you didn't explicitly change.
Please reach out by creating an issue.
We love feedback, so even if we've answered all your questions, please let us know in a comment.