OpenAPI to TypeScript generator and mock server

This project is maintained by pmcelhaney

Got 60 Seconds? Try me!

Copy the following command into your terminal. The only prerequisite is Node 16+.

npx counterfact@latest api --open

What does that command do?

  1. installs the @latest version of counterfact
  2. reads an OpenAPI 3 document (
  3. generates TypeScript files in the api directory
  4. starts a server which implements the API
  5. opens your browser to Swagger UI (--open)

You can use Swagger to try out the auto-generated API. Out of the box, it returns random responses using metadata from the OpenAPI document. Edit the files under ./api/routes to add more realistic behavior. There's no need to restart the server.

To learn more, see the Usage Guide.