Counterfact

OpenAPI to TypeScript generator and mock server

This project is maintained by pmcelhaney

MIT License TypeScript Coverage Status


Counterfact

A Mock Server for High-performing Front-end Teams

Quick Start | Documentation | Changelog | Contributing


Counterfact is a free and open source mock server designed to hit the sweet spot every front-end engineer craves: real enough to be useful but fake enough to be usable. It stands in for the back-end code that doesn't exist yet or is too complex / rigid to suit your front-end development and testing workflow.

Counterfact enables API-first development where the front-end and back-end are built in parallel. It can even be used to prototype the back-end, rapidly iterate on the API, and defer big decisions / investments until the last responsible moment.

Like your favorite pair of sweatpants, Counterfact is lightweight, flexible, and comfortable; it stretches and shrinks to fit your project's unique contours. Best of all, it makes your ass boss look good. Go ahead, try it on.

Why Use Counterfact?

10 Second Quick Start

To see Counterfact in action run the following command in your terminal:

npx counterfact@latest https://petstore3.swagger.io/api/v3/openapi.yaml api

This command installs Counterfact from npm, sets up a mock server implementing the Swagger Petstore, and opens a dashboard in a web browser. As long as you have Node 16 or later installed, it should "just work".

Documentation

For more detailed information, such as how to go beyond simple mocks that return random values, visit our tutorial and usage guide.

Similar Tools and Alternatives

While Counterfact offers a unique approach to API mocking that we believe provides the best overall DX, we understand the importance of having the right tool for your specific needs. Here are some similar tools and alternatives you might find useful:

Mirage JS has more or less the same goals as Counterfact and very different approaches to achieving them. Some notable differences are that it runs in a browser instead of Node, does not integrate with OpenAPI, and does support GraphQL.

If your goal is to get a server up and running quickly and your API doesn't do much beyond storing and retrieving data, JSON Server may be a great fit for you.

If your mocking needs are relatively simple and you're shopping for someone who has no reason to have Node installed their computer, Beeceptor, Mockoon, and Mocky.io are worth checking out. Mocky is free; the others have free and paid tiers.

Feedback and Contributions

We value all of your feedback and contributions, including šŸ’Œ love letters , šŸ’” feature requests, šŸž bug reports, and āœļø grammatical nit-picks in the docs. Please create an issue, open a pull request, or reach out to pmcelhaney@gmail.com.

Welcome to the bottom of the README club! Since you've come this far, go ahead and smash that like and subscā€¦ er, uh, give this project a ā­ļø on GitHub! šŸ™šŸ¼